v1

latestOpenAPI 3.1.02026-07-247328324.6 KB

API authentication

Create an authorize

post/oauth/authorize

Headers

IdempotencyKeystring

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Example:978771af-77de-4e24-ba39-f602502ceb78

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Request body

response_type'code' required

client_idstring required

Non-empty text string

redirect_uristring uri required

HTTP(S) URL

statestring

Non-empty text string

scopestring[]

code_challengestring

Non-empty text string

code_challenge_method'plain' | 'S256'

prompt'none' | 'login' | 'consent' | 'select_account'

audiencestring

Non-empty text string

access_type'online' | 'offline'

resourcestring uri

HTTP(S) URL

Example request

{
  "redirect_uri": "https://www.acme.com",
  "resource": "https://www.acme.com"
}

Response

Successful operation

response_type'code' required

client_idstring required

Non-empty text string

redirect_uristring uri required

HTTP(S) URL

statestring

Non-empty text string

scopestring[]

code_challengestring

Non-empty text string

code_challenge_method'plain' | 'S256'

prompt'none' | 'login' | 'consent' | 'select_account'

audiencestring

Non-empty text string

access_type'online' | 'offline'

resourcestring uri

HTTP(S) URL

idstring required

An object id with prefix

created_atstring date-time required

Creation date and time

created_bystring required

ID of the user that created this object

updated_atstring date-time required

Last update date and time

updated_bystring required

ID of the user that last updated this object

Example response

{
  "redirect_uri": "https://www.acme.com",
  "resource": "https://www.acme.com",
  "id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}