Sign in
Auth Server Claims

Update an auth server claim

Update a claim for a given auth server.

patch/v1/auth-servers/{authServerId}/claims/{claimId}

Request body

namestring

The name of the claim

valuestring

Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.

include_in_tokenboolean

Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint.

include_in_all_scopesboolean

Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it.

include_in_scopesstring[]

Specifies the scopes IDs in which the claim is included

enabledboolean

Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint.

Response

A claim

idstring uuid required

The ID of the claim

namestring required

The name of the claim

valuestring required

Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.

include_in_tokenboolean required

Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint.

include_in_all_scopesboolean required

Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it.

include_in_scopesstring[] required

Specifies the scopes IDs in which the claim is included

enabledboolean required

Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes