Delete an auth server client

Delete a client for a given auth server. All tokens associated with the client will also be deleted. This action is irreversible.

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}
 

Test a claim template for a client

Test a claim template for a client. Utility function to test claim templates against a client and verify the resulting claim values.

post

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

Body

application/json

Claim to be tested

object

A mapstring of the claims and templates

Response

application/json

Result of a claim test

TestClaimResult

TestClaimResultobject

A mapany of the claim that have been templated

post/auth-servers/{authServerId}/clients/{clientId}/test-claim

Body

{ "destination": "anywhere", "uuidv4": "${ uuidv4 }" }
 
application/json

List all auth server client tokens

List all the tokens for a given client.

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 tokens returned in the response.

Show Child Parameters

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

application/json

List of tokens

TokenList

dataarray[object]required
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/auth-servers/{authServerId}/clients/{clientId}/tokens
 
application/json

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