OAuth2Client

Object

@anyScope

@anyScope(names: ["urn:cx/tenants:data/oAuth2Clients:read", "urn:cx/tenants:data/oAuth2Clients:manage"])

_createdBy

Who has created this client.

_createdDateTime

When client was created.

_id

Unique identifier of a client

_kind

Record type, always OAuth2Client

_updatedBy

Who modified this client the last time.

_updatedDateTime

Last time when client was modified.

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. For non-confidential clients is always null .

code

Unique code of an application. Format: urn:{vendor}/{component} , e.g. urn:cx/meetings .

credentials

OAuth2 credentials which OAuth2Client uses to obtain access tokens.

declaredResources

API resources provided by this OAuth2 client as a resource server, to establish and secure it's own API. For non-resource servers is always null .

declaredScopes

OAuth2 scopes provided by this OAuth2 client as a resource server, to secure it's own API. For non-resource servers is always null .

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.

deletable

Whether a client can be deleted.

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.

resourceServer

Whether this application represents a resource server, i.e. provides it's own API. Applicable only for clients with clientCredentials flow enabled.

updatable

Whether a client can be modified.