CreateClientRequest

Client creation request containing client details

Name	Type	Description	Notes
name	String	The display name shown to the user on the consent screen. It has to be between 3 and 256 characters long.	[required] [example: Example Client] [minLength: 3] [maxLength: 256]
description	String	The free-text description shown next to the name on the consent screen, at most 255 characters.	[optional] [example: Description of the client] [minLength: 0] [maxLength: 255]
logo	String	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.	[required] [example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==] [minLength: 1] [pattern: /^data:image\/(?:png|jpeg|jpg|svg\\+xml);base64,.*.{1,}/]
scopes	Set	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.	[required]
allow_pkce	Boolean	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] [example: true]
website_url	String	The URL of the client home page, offered to the user before they consent. The value has to be an http or https URL.	[required] [example: http://example.com] [minLength: 1] [pattern: /^(https?:\/\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(:\\d+)?(\/[a-zA-Z0-9-._~:\/?#\\[\\]@!$&'()*+,;=]*)?$|^https?:\/\/(\\d{1,3}\\.){3}\\d{1,3}(:\\d+)?(\/[a-zA-Z0-9-._~:\/?#\\[\\]@!$&'()*+,;=]*)?$/]
terms_url	String	The URL of the client terms of service, linked from the consent screen. The value has to be an http or https URL.	[required] [example: http://example.com/terms] [minLength: 1] [pattern: /^(https?:\/\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(:\\d+)?(\/[a-zA-Z0-9-._~:\/?#\\[\\]@!$&'()*+,;=]*)?$|^https?:\/\/(\\d{1,3}\\.){3}\\d{1,3}(:\\d+)?(\/[a-zA-Z0-9-._~:\/?#\\[\\]@!$&'()*+,;=]*)?$/]
policy_url	String	The URL of the client privacy policy, linked from the consent screen. The value has to be an http or https URL.	[required] [example: http://example.com/policy] [minLength: 1] [pattern: /^(https?:\/\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(:\\d+)?(\/[a-zA-Z0-9-._~:\/?#\\[\\]@!$&'()*+,;=]*)?$|^https?:\/\/(\\d{1,3}\\.){3}\\d{1,3}(:\\d+)?(\/[a-zA-Z0-9-._~:\/?#\\[\\]@!$&'()*+,;=]*)?$/]
redirect_uris	Set	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.	[required]
allowed_origins	Set	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.	[required]
logout_redirect_uri	String	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.	[required] [example: http://example.com/logout] [minLength: 1] [pattern: /^(https?:\/\/)?([a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,}(:\\d+)?(\/[a-zA-Z0-9-._~:\/?#\\[\\]@!$&'()*+,;=]*)?$|^https?:\/\/(\\d{1,3}\\.){3}\\d{1,3}(:\\d+)?(\/[a-zA-Z0-9-._~:\/?#\\[\\]@!$&'()*+,;=]*)?$/]
is_public	Boolean	Whether the client is offered to third-party tenants rather than only to the tenant that registers it.	[optional] [example: false]