HoxtonAi
Powered by Redocly

OAuth Clients

APIs to manage OAuth clients.

Create/Update OAuth client

Update an OAuth client.

Securityo_auth
Request
Request Body schema: application/json
required

A client to update.

callbacks
Array of strings
clientId
string
grantTypes
required
Array of strings
Items Enum: "authorization_code" "client_credentials" "password" "refresh_token"
name
required
string
organisationId
required
string
Responses
201

OK.

204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

404

Not found.

412

Precondition failed.

422

Unprocessable entity.

500

Failed.

put/oauth-clients
Request samples
application/json
{
  • "callbacks": [
    ],
  • "clientId": "string",
  • "grantTypes": [
    ],
  • "name": "string",
  • "organisationId": "532ec32c-6f32-457f-8285-3438b2599d9b"
}
Response samples
application/json
{
  • "callbacks": [
    ],
  • "clientId": "string",
  • "clientSecret": "string",
  • "grantTypes": [
    ],
  • "name": "string"
}

Delete OAuth client

Remove an OAuth client.

Securityo_auth
Request
path Parameters
oAuthClientId
required
string

The ID of the OAuth client to delete.

Responses
204

OK.

401

Authentication failed.

403

Not allowed.

404

Not found.

422

Unprocessable entity.

500

Failed.

delete/oauth-clients/{oAuthClientId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get OAuth client.
Get an OAuth client.


Securityo_auth 
Request 
path Parameters
oAuthClientId
required
string
The ID of the OAuth client to delete.


 
Responses 
200
OK.


400
Bad request.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


get/oauth-clients/{oAuthClientId}
Request samples 
Response samples 
application/json
{
  • "callbacks": [
    ],
  • "clientId": "string",
  • "clientSecret": "string",
  • "grantTypes": [
    ],
  • "name": "string"
}
Rotate client secret
Rotate an OAuth client secret ID


Securityo_auth 
Request 
path Parameters
oAuthClientId
required
string
The ID of the OAuth client to update.


 
Responses 
200
OK.


400
Bad request.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


post/oauth-clients/{oAuthClientId}/rotate-secret
Request samples 
Response samples 
application/json
{
  • "callbacks": [
    ],
  • "clientId": "string",
  • "clientSecret": "string",
  • "grantTypes": [
    ],
  • "name": "string"
}