Create a new client secret
Create a new client secret for a given client. Multiple secrets can be active simultaneously for a single client.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Body
application/json
Body
Secret to be created
CreateSecretPayload
The OAuth 2.0 client secret
Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae
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
Response
A Client Secret item
ClientSecretItem
The client secret. The secret value is only returned when creating a new secret item.
The ID of the client secret
Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.
Default:true
The OAuth 2.0 client secret
Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae
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 a client secret
Get a specific client secret for a given client.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
The client secret ID
Example:07d05309-45cc-4b37-92fb-1524846deec3
Response
application/json
Response
A Client Secret item
ClientSecretItem
The client secret. The secret value is only returned when creating a new secret item.
The ID of the client secret
Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.
Default:true
The OAuth 2.0 client secret
Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae
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 a client secret
Update a client secret for a given client, such as enabling or disabling the secret.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
The client secret ID
Example:07d05309-45cc-4b37-92fb-1524846deec3
Body
application/json
Body
Secret to be updated
UpdateSecretPayload
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
Response
A Client Secret item
ClientSecretItem
The client secret. The secret value is only returned when creating a new secret item.
The ID of the client secret
Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.
Default:true
The OAuth 2.0 client secret
Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae
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 a client secret
Delete a client secret for a given client. This action is irreversible.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
The client secret ID
Example:07d05309-45cc-4b37-92fb-1524846deec3
Response
Response
Success
Authentication
Path Parameters
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.
Path Parameters
The auth server ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The OAuth 2.0 client ID
Match pattern:[-_\w]+
>= 1 characters<= 36 characters
Example:kYa9iQFU5xPDSIUH9z1z
Response
application/json
Response
Result of a refreshed secret
RefreshedSecret
The result of a refreshed client secret.
The OAuth 2.0 client secret
Example:YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae