Get an auth server claim
Get a claim for given auth server.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The claim ID
Example:07d05309-45cc-4b37-92fb-1524846deec3
Response
application/json
Response
A claim
Claim
The ID of the claim
The name of the claim
>= 1 characters
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
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
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
Specifies the scopes IDs in which the claim is included
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
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update an auth server claim
Update a claim for a given auth server.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The claim ID
Example:07d05309-45cc-4b37-92fb-1524846deec3
Body
application/json
Body
Claim to be updated
The name of the claim
>= 1 characters
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
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.
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.
Specifies the scopes IDs in which the claim is included
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
Response
A claim
Claim
The ID of the claim
The name of the claim
>= 1 characters
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
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
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
Specifies the scopes IDs in which the claim is included
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
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete an auth server claim
Delete a claim for a given auth server. If the claim is included in any scopes, it will be removed from those scopes.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The claim ID
Example:07d05309-45cc-4b37-92fb-1524846deec3
Response
Response
Success
Authentication
Path Parameters
Auth Server Scopes
Scopes define the extent of access that an access token grants to a Client. The management API will give you the ability to create, configure and manage multiple Scopes per Auth Server, and restrict their usage by Client.
List all auth server scopes
List all the scopes for a given auth server.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
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
Filter scopes returned in the response.
Show Child Parameters
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
List of scopes
ScopeList
Show Child Parameters
returns the pagination information