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
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create a new auth server scope
Create a new scope for a given auth server. The name attribute must be unique within the auth server.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
Scope to be created
The name of the scope
>= 1 characters
Description of the scope
Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token.
Default:false
Specifies whether to include the scope in the metadata document
Default:false
Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token.
Default:true
Response
application/json
Response
A scope
Scope
The ID of the scope
The name of the scope
>= 1 characters
Description of the scope
Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token.
Default:false
Specifies whether to include the scope in the metadata document
Default:false
Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token.
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
Get an auth server scope
Get a scope for given auth server.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The scope ID
Example:c5e12516-182c-4928-ae04-05374b3b1cca
Response
application/json
Response
A scope
Scope
The ID of the scope
The name of the scope
>= 1 characters
Description of the scope
Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token.
Default:false
Specifies whether to include the scope in the metadata document
Default:false
Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token.
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