Create Client Secret

This endpoint is used to create a new Client Secret for a given set of API Credentials.

The client_secret value is only ever returned in the response to this request. Make sure to store it securely, as it cannot be retrieved again - if it is lost, a new Client Secret must be created.

The returned client_secret, together with the existing client_id (X-Client-Id), can be used to authenticate via the /v1/oauth/token endpoint.

A single client_id can have multiple active Client Secrets at once, allowing clients to rotate secrets without downtime. The client_secret_id returned alongside the client_secret is used only to manage (list or revoke) that specific secret - it is not itself used to authenticate.

📘

Note:

For guidance on rotating Client Secrets, please refer to our guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Descriptive label used to recognise the Client Secret.

Headers
string
required

The API Client Identifier (Service Application Identifier).

Responses

404

The request contains a client_id which could not be found.

405

The request uses an unexpected HTTP method.

5XX

An unexpected error occurred on the server side.

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json