Magidoc

OAuth2ScopeRequest
Input Object

A request to create or update an OAuth2 scope. For an update operation, not specifying a field in the request means that it's value will not be updated.

Fields

#

_id

ID

Unique identifier of a scope. Used to refer to a scope for update or delete.

_kind

ID !
Non-null

Record type, always OAuth2Scope .

assignedToUI

Boolean

Whether this scope is assigned to Carerix UI client.

code

String

Unique code of a scope. When a client whom a scope is assigned to gets an access token, this code will be put into a scope claim. Format: urn:{vendor}/{component}:{resources}:{action} , e.g. urn:cx/meetings:data:manage or urn:cx/tenants:data/oAuth2Clients:read . This value cannot be changed after scope is created, i.e. specifying a code means that either a scope is being referenced by it for update/delete instead of _id or a new scope has to be created.

description

String

Displayable description.

name

String

Displayable name.

protocolMappers

ProtocolMapperPageRequest

Protocol mappers used to augment access tokens having this scope with additional claims.