Magidoc

ProtocolMapper
Object

Protocol mapper provides a mechanism to augment access tokens with additional claim if standard ones are not enough to solve a specific problem. Such claim is calculated and added only if OAuth2Client whom an access token is being issued to has an OAuth2Scope (i.e. requested explicitly or as a default) which declares a protocol mapper.

Fields

#

_id

ID !
Non-null

Unique identifier of a protocol mapper.

_kind

ID !
Non-null

Record type. Currently only ProtocolMapperUserExpression is supported.

claim

String

For ProtocolMapperUserExpression , this is a name of a claim which will be added into a token.

code

String !
Non-null

Unique code of a protocol mapper.

expression

String

For ProtocolMapperUserExpression , this is an expression string which will be used to calculate claim's value. It supports placeholders for user's identifier, tenant identifier and user attributes. Example: ${id}@${tenant}.carerix.io expression string will be evaluated into f:6bd50030-b8e0-424d-ada6-7f255059e79b:123@test.carerix.io when retrieving a token for tenant test and user with f:6bd50030-b8e0-424d-ada6-7f255059e79b:123 identifier.

Interfaces

#

Also implements APIResource .

Usages

#

References

#