OAuth2ClientRequest

Input Object

_kind

Record type, must be always OAuth2Client .

access

Access configuration of a client: describes how an access token can be obtained.

assignedResources

Permission matrix of this client: API resources (declared by another clients) and permissions on their operations. Specifying null value for this field will not clear the scopes, instead explicitly specify an empty items list and _patch being equal to replaceMerge to do so. Not available non-confidential clients.

code

Unique code of an application. Format: urn:{vendor}/{component} , e.g. urn:cx/meetings . This value cannot be changed after client is created.

declaredResources

API resources provided by this OAuth2 client as a resource server, to establish and secure it's own API. Specifying null value for this field will not clear the scopes, instead explicitly specify an empty items list to do so. Not available non-resource servers.

declaredScopes

OAuth2 scopes provided by this OAuth2 client as a resource server, to secure it's own API. Specifying null value for this field will not delete the scopes, instead explicitly specify an empty items list to do so. Not available non-resource servers.

defaultScopes

OAuth2 scopes assigned to this client, granting it access to corresponding APIs. Such scopes will be always included into scope claim of access tokens issued for this client. Specifying null value for this field will not clear the scopes, instead explicitly specify an empty items list to do so.

enabled

Whether application can obtain access tokens.

name

Displayable name.

optionalScopes

OAuth2 scopes assigned to this client, granting it access to corresponding APIs. Such scopes must be explicitly requested in order to be included into scope claim of access tokens issued for this client. Specifying null value for this field will not clear the scopes, instead explicitly specify an empty items list to do so.

resourceServer

Whether this application represents a resource server, i.e. provides it's own API. Applicable only for clients with clientCredentials flow enabled. This value cannot be changed after client is created.