Auth Server Claims

Claims are statements about the Client, included in tokens issued by the Auth Server. The management API will give you the ability to create, configure and manage multiple Claims per Auth Server, and include them in tokens based on the requested Scopes.

List all auth server claims

List all the claims for a given auth server.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

sortstring

The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

filterobject

Filter claims returned in the response.

Show Child Parameters

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

List of claims

ClaimList

dataarray[object]required
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/auth-servers/{authServerId}/claims
 
application/json

Create a new auth server claim

Create a new claim for a given auth server. The name attribute will appear in the JWT access token as a claim with the given case-sensitive name. The value attribute will be used to populate the claim value in the JWT access token. The value can be templated, which allows you to use variables like ${ uuidv4 } to generate dynamic values. Claim values are hydrated based on their types, which may include JSON.

post

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Claim to be created

namestringrequired

The name of the claim

>= 1 characters

valuestringrequired

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.

>= 1 characters

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.

Default:false

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.

Default:false

include_in_scopesarray[string](uuid)

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.

Default:true

Response

application/json

A claim

Claim

idstring(uuid)required

The ID of the claim

namestringrequired

The name of the claim

>= 1 characters

valuestringrequired

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.

>= 1 characters

include_in_tokenbooleanrequired

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.

Default:false

include_in_all_scopesbooleanrequired

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.

Default:false

include_in_scopesarray[string](uuid)required

Specifies the scopes IDs in which the claim is included

enabledbooleanrequired

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

Default:true

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/auth-servers/{authServerId}/claims

Body

{ "name": "Claim", "value": "Claim Value", "include_in_token": true, "include_in_all_scopes": false, "include_in_scopes": [ "c5e12516-182c-4928-ae04-05374b3b1cca", "b5525b78-f3a0-4bd6-befc-7696be58717e" ], "enabled": true }
 
application/json

Get an auth server claim

Get a claim for given auth server.

get

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

claimIdstring(uuid)required

The claim ID

Example:07d05309-45cc-4b37-92fb-1524846deec3

Response

application/json

A claim

Claim

idstring(uuid)required

The ID of the claim

namestringrequired

The name of the claim

>= 1 characters

valuestringrequired

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.

>= 1 characters

include_in_tokenbooleanrequired

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.

Default:false

include_in_all_scopesbooleanrequired

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.

Default:false

include_in_scopesarray[string](uuid)required

Specifies the scopes IDs in which the claim is included

enabledbooleanrequired

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

Default:true

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/auth-servers/{authServerId}/claims/{claimId}
 
application/json

Update an auth server claim

Update a claim for a given auth server.

patch

Path Parameters

authServerIdstring(uuid)required

The auth server ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

claimIdstring(uuid)required

The claim ID

Example:07d05309-45cc-4b37-92fb-1524846deec3

Body

application/json

Claim to be updated

namestring

The name of the claim

>= 1 characters

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.

>= 1 characters

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_scopesarray[string](uuid)

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

application/json

A claim

Claim

idstring(uuid)required

The ID of the claim

namestringrequired

The name of the claim

>= 1 characters

valuestringrequired

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.

>= 1 characters

include_in_tokenbooleanrequired

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.

Default:false

include_in_all_scopesbooleanrequired

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.

Default:false

include_in_scopesarray[string](uuid)required

Specifies the scopes IDs in which the claim is included

enabledbooleanrequired

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

Default:true

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

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

Body

{ "name": "Updated Claim", "value": "Updated Claim Value", "include_in_token": true, "include_in_all_scopes": true, "include_in_scopes": [ "c5e12516-182c-4928-ae04-05374b3b1cca" ], "enabled": false }
 
application/json