Sign in

v1

latestOpenAPI 3.0.1License2026-07-17236107.1 KB
developers

Get Client Token

Gets Client Token

post/get-client-token

Request body

op_configuration_endpointstring required

The openid configuration endpoint URL. If missing, then op_host must be defined.

op_hoststring

Deprecated in favor of op_configuration_endpoint. It will be removed in future version(s). Provide the URL of OpenID Provider (OP) in this field. If missing, then op_configuration_endpoint must be defined.

op_discovery_pathstring

Deprecated in favor of op_configuration_endpoint. It will be removed in future version(s). Provide path to the OpenID Connect Provider's discovery document in this field. For example, if it is 'https://example.com/.well-known/openid-configuration' then the path is blank. But if it is 'https://example.com/oxauth/.well-known/openid-configuration' then the path is '/oxauth'

scopestring[]
client_idstring required
client_secretstring required
authentication_methodstring

if value is missed then basic authentication is used. Otherwise it's possible to set private_key_jwt value for Private Key authentication.

algorithmstring

optional but is required if authentication_method=private_key_jwt. Valid values are none, HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512

key_idstring

optional but is required if authentication_method=private_key_jwt. It has to be valid key id from key store.

Example request

{
  "op_configuration_endpoint": "https://op.example.com/acme/.well-known/openid-configuration",
  "op_host": "https://<ophostname>",
  "op_discovery_path": "/oxauth",
  "scope": [
    "openid"
  ],
  "client_id": "@!1736.179E.AA60.16B2!0001!8F7C.B9AB!0008!A2BB.9AE6.5F14.B387",
  "client_secret": "f436b936-03fc-433f-9772-53c2bc9e1c74"
}

Response

OK

scopestring[] required
access_tokenstring required
expires_ininteger required
refresh_tokenstring required

Example response

{
  "scope": [
    "openid",
    "oxd"
  ],
  "access_token": "b75434ff-f465-4b70-92e4-b7ba6b6c58f2",
  "expires_in": 299
}