Magidoc

OAuth2Scope
Object

OAuth2 scope describes a right to access a certain part of API by applications whom it was assigned. OAuth2 scope is always declared by OAuth2 client - a service which provides such API.

Fields

#

_createdBy

Auditor

Who has created this scope.

_createdDateTime

Instant

When scope was created.

_id

ID !
Non-null

Unique identifier of a scope

_kind

ID !
Non-null

Record type, always OAuth2Scope

_updatedBy

Auditor

Who modified this scope the last time.

_updatedDateTime

Instant

Last time when scope was modified.

assignedToUI

Boolean !
Non-null

Whether this scope is assigned to Carerix UI client.

client

OAuth2Client

OAuth2 client which declared this scope. If API consumer has no permissions to retrieve a referenced client, null will be returned here as well as bunch of GraphQL errors.

code

String !
Non-null

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.

description

String

Displayable description.

name

String !
Non-null

Displayable name.

protocolMappers

ProtocolMapperPage !
Non-null

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

Interfaces

#

Also implements APIResource .

Usages

#

References

#