ProtocolMapperRequest

Input Object

_id

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

_kind

Record type. Currently only ProtocolMapperUserExpression is supported.

claim

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

code

Unique code of a protocol mapper. Used for referencing in update/delete calls. Required for creation. Format: urn:{vendor}/{component}:protocolMappers/{name} , where urn:{vendor}/{component} is equal to the OAuth2Client code where an OAuth2Scope is declared at. Example: urn:cx/test:protocolMappers/usercode .

expression

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.