Skip to content

Latest commit

 

History

History
48 lines (40 loc) · 4.25 KB

ClientResponse.md

File metadata and controls

48 lines (40 loc) · 4.25 KB

ClientResponse

The whole stored record of an OAuth2 client, including the secret and every address the client is allowed to use.

Properties

Name Type Description Notes
name str The display name shown to the user on the consent screen, between 3 and 256 characters. [optional]
description str The free-text description shown next to the name on the consent screen, at most 255 characters. [optional]
tenant int The identifier of the portal the client belongs to. A client is visible only inside its own tenant, apart from the unauthenticated public info read. [optional]
scopes List[str] The permissions the client may ask for, named as they appear in the tenant scope catalogue - for example files:read, rooms:write or openid. A client cannot request a scope that is not listed here. [optional]
enabled bool Whether the client may currently obtain tokens. A disabled client keeps its registration and the tokens already issued to it, but new authorization requests for it are refused. [optional]
client_id str The generated identifier of the client, sent as client_id in every OAuth2 request. It is assigned when the client is registered and never changes afterwards. [optional]
client_secret str The client secret, which the client presents at the token endpoint when it authenticates with client_secret_post. It is omitted from the response rather than sent as null when the client has none. [optional]
website_url str The URL of the client home page, offered to the user before they consent. [optional]
terms_url str The URL of the client terms of service, linked from the consent screen. [optional]
policy_url str The URL of the client privacy policy, linked from the consent screen. [optional]
logo str The client logo as a data URI carrying base64 image data, shown on the consent screen. Only png, jpeg, jpg and svg+xml are accepted, the whole string may not exceed 2000000 characters and the decoded image may not exceed 256000 bytes. [optional]
authentication_methods List[str] How the client authenticates itself at the token endpoint: client_secret_post for a confidential client that sends its secret, none for a public client that proves itself with PKCE instead. [optional]
redirect_uris List[str] The URIs an authorization code may be delivered to. An authorization request naming any other URI is refused, and the set holds between 1 and 12 addresses. [optional]
allowed_origins List[str] The web origins allowed to call the portal on behalf of this client, used for the CORS check. The set holds between 1 and 12 addresses. [optional]
logout_redirect_uris List[str] The URIs the user may be sent back to once they have logged out. [optional]
created_on datetime When the client was registered, as an ISO-8601 timestamp with a zone offset. [optional]
created_by str The identifier of the user who registered the client. A plain user may read and change only the clients where this is their own identifier. [optional]
modified_on datetime When the client was last changed, as an ISO-8601 timestamp with a zone offset. [optional]
modified_by str The identifier of the user who last changed the client. [optional]
is_public bool Whether the client is offered to third-party tenants rather than only to the tenant that registered it. [optional]

Example

from docspace_api_sdk.models.client_response import ClientResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ClientResponse from a JSON string
client_response_instance = ClientResponse.from_json(json)
# print the JSON string representation of the object
print(ClientResponse.to_json())

# convert the object into a dict
client_response_dict = client_response_instance.to_dict()
# create an instance of ClientResponse from a dict
client_response_from_dict = ClientResponse.from_dict(client_response_dict)

[Back to Model list] [Back to API list] [Back to README]