CreateClientRequest.md

CreateClientRequest

Client creation request containing client details

Properties

Name	Type	Description	Notes
name	str	The display name shown to the user on the consent screen. It has to be between 3 and 256 characters long.
description	str	The free-text description shown next to the name on the consent screen, at most 255 characters.	[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.
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.
allow_pkce	bool	Whether the client may use PKCE. Turning it on lets the client authenticate with the none method and prove itself with a code verifier instead of sending a secret, which is what a client that cannot keep a secret needs.	[optional]
website_url	str	The URL of the client home page, offered to the user before they consent. The value has to be an http or https URL.
terms_url	str	The URL of the client terms of service, linked from the consent screen. The value has to be an http or https URL.
policy_url	str	The URL of the client privacy policy, linked from the consent screen. The value has to be an http or https URL.
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.
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.
logout_redirect_uri	str	The single URI the user may be sent back to once they have logged out. The value has to be an http or https URL.
is_public	bool	Whether the client is offered to third-party tenants rather than only to the tenant that registers it.	[optional]

Example

from docspace_api_sdk.models.create_client_request import CreateClientRequest

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

# convert the object into a dict
create_client_request_dict = create_client_request_instance.to_dict()
# create an instance of CreateClientRequest from a dict
create_client_request_from_dict = CreateClientRequest.from_dict(create_client_request_dict)

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