Delete all auth server client tokens

Revoke all tokens for a given client. Revoked tokens can no longer be used to access resources when introspection is enabled on the client.

delete

Path Parameters

authServerIdstring(uuid)required

The auth server ID

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

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

Response

Success

delete/auth-servers/{authServerId}/clients/{clientId}/tokens
 

Get an auth server client token

Get a token for given client and auth server.

get

Path Parameters

authServerIdstring(uuid)required

The auth server ID

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

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

tokenIdstring(uuid)required

The token ID

Example:2cec70a4-d197-495c-8f3e-c0a1199d1da4

Response

application/json

A token

Token

idstring(uuid)required

The ID of the token

granted_scope_namesarray[string]required

The scopes that the token has been granted

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

expires_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of the expiration date

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

get/auth-servers/{authServerId}/clients/{clientId}/tokens/{tokenId}
 
application/json

Delete an auth server client token

Revoke a token for a given client and auth server. Revoked tokens can no longer be used to access resources when introspection is enabled on the client.

delete

Path Parameters

authServerIdstring(uuid)required

The auth server ID

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

clientIdstringrequiredread-only

The OAuth 2.0 client ID

Match pattern:[-_\w]+

>= 1 characters<= 36 characters

Example:kYa9iQFU5xPDSIUH9z1z

tokenIdstring(uuid)required

The token ID

Example:2cec70a4-d197-495c-8f3e-c0a1199d1da4

Response

Success

delete/auth-servers/{authServerId}/clients/{clientId}/tokens/{tokenId}
 

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