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
Authentication
Path Parameters
Update an auth server scope
Update a scope for a given auth server.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The scope ID
Example:c5e12516-182c-4928-ae04-05374b3b1cca
Body
application/json
Body
Scope to be update
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.
Specifies whether to include the scope in the metadata document
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.
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
Delete an auth server scope
Delete a scope for a given auth server. If the scope is included in any clients, it will be removed from those clients.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The scope ID
Example:c5e12516-182c-4928-ae04-05374b3b1cca
Response
Response
Success
Authentication
Path Parameters
TestClaimResult
objectA mapany of the claim that have been templated