Create New Client Credentials
This will generate a new client credential. The response will include the clientSecret
. The clientId
and clientSecret
values should be utilized for subsequent calls to the /api/v0/oauth/token
endpoint. Once generated, the clientSecret
cannot be retrieved, so please store it safely.
Sample Request
{
"name": "My New Credentials",
"expires": "2028-06-21T00:00:00.000Z"
}
Request Field | |
---|---|
name | A name for the generated credentials. This will only be visible from the GET client-credentials method |
expires | (Optional) Provide a future date to automatically expire the created credentials. Providing a null value will disable automatic expiration |
Sample Response
{
"credentialId": "4eb40c8b-76d9-4ad3-9580-d327bbd99d15",
"clientId": "ac9ab00ff44745d199981506313cfa72",
"name": "My New Credentials",
"secret": "iObGKtihdEScOmDiZxZ+6Q==",
"expires": "2028-06-21T00:00:00.000Z",
"created": "2024-06-21T15:19:05.319Z"
}
Response Field | |
---|---|
| The internal ID of the generated credentials |
| The |
| User provided internal name for the credentials |
| The This value will only be displayed once. Please store it securely. |
| The user provided optional expiration date |
| The date the credentials were created |