Create an OAuth Client

POST

/oauth-clients

Last modified:2026-08-12 21:59:30

OperationId:createOauthClient

Registers a new OAuth client.

client-id is required and is the primary key. client-secret is generated automatically unless one is supplied; the generated value is returned in this response and cannot be retrieved later except with include-secret=yes on a read.

Creating over an existing client-id returns 409 rather than overwriting the existing client's secret — use PUT /oauth-clients/{client-id} to edit.

Requires full Super User (Super User Read Only is refused).

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The created client, including the plaintext secret. This is the only unconditional exposure of the secret — record it now.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠409

Request Example

Shell

JavaScript

Java

Swift

cURL

Let the API generate the secretClient-credentials style client with no redirect URIMigrating an existing client with a known secretExisting client-id → expect 409Relative redirect URI → expect 400

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/oauth-clients' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "client-id": "horizon.example",
    "redirect-uri": "https://portal.example.com/oauth/callback"
}'

Response Example

200 - Created with a generated secret

{
    "client-id": "horizon.example",
    "client-secret": "0f5c2a1b9d8e4f7a0c3b6d1e8f2a4c9b",
    "redirect-uri": "https://portal.example.com/oauth/callback",
    "notes": "The client secret is shown here on create. It can be read back later only with include-secret=yes."
}

Modified at 2026-08-12 21:59:30

List OAuth Clients

Count OAuth Clients