Get a client secret

Get a specific client secret for a given client.

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

clientSecretIdstring(uuid)required

The client secret ID

Example:07d05309-45cc-4b37-92fb-1524846deec3

Response

application/json

A Client Secret item

ClientSecretItem

The client secret. The secret value is only returned when creating a new secret item.

idstring(uuid)required

The ID of the client secret

enabledbooleanrequired

Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.

Default:true

secretstring

The OAuth 2.0 client secret

Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

get/auth-servers/{authServerId}/clients/{clientId}/secrets/{clientSecretId}
 
application/json

Update a client secret

Update a client secret for a given client, such as enabling or disabling the secret.

patch

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

clientSecretIdstring(uuid)required

The client secret ID

Example:07d05309-45cc-4b37-92fb-1524846deec3

Body

application/json

Secret to be updated

UpdateSecretPayload

enabledboolean

Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.

Default:true

Response

application/json

A Client Secret item

ClientSecretItem

The client secret. The secret value is only returned when creating a new secret item.

idstring(uuid)required

The ID of the client secret

enabledbooleanrequired

Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.

Default:true

secretstring

The OAuth 2.0 client secret

Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

patch/auth-servers/{authServerId}/clients/{clientId}/secrets/{clientSecretId}

Body

{}
 
application/json

Delete a client secret

Delete a client secret for a given client. 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

clientSecretIdstring(uuid)required

The client secret ID

Example:07d05309-45cc-4b37-92fb-1524846deec3

Response

Success

delete/auth-servers/{authServerId}/clients/{clientId}/secrets/{clientSecretId}
 

Refresh an auth server client secret

Regenerate the client secret for this auth server client. The previous secret is immediately invalidated, but existing tokens remain valid until they expire. To revoke existing tokens, use the delete tokens endpoint.

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

Response

application/json

Result of a refreshed secret

RefreshedSecret

The result of a refreshed client secret.

secretstringrequired

The OAuth 2.0 client secret

Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae

post/auth-servers/{authServerId}/clients/{clientId}/refresh-secret
 
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