Check and validate an Oauth Access token.

GET

/auth/oauth

The user system supports an OAuth 2.0 Authorization Code Grant. This call validates that a generated access key is valid.

Request

Authorization

Add parameter in header

token

Example:

token: ********************

Header Params

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorised

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/auth/oauth' \
--header 'Accept: application/json' \
--header 'token: <api-key>'

Response Example

200 - OK

{
  "authenticationFramework": "oauth",
  "status": "active",
  "userId": "69f464fa-bca2-4f2a-83b1-0c69819c5cd0",
  "applications": [
    {
      "active": true,
      "accountId": "ffe4f42e-7c1a-4ea3-9ec8-087d4a1071e6",
      "applicationId": "0537b17c-ab62-491c-8085-9ac2b6206346"
    },
    {
      "active": true,
      "accountId": "ffe4f42e-7c1a-4ea3-9ec8-087d4a1071e6",
      "applicationId": "0537b17c-ab62-491c-8085-9ac2b6206346"
    }
  ],
  "active": true,
  "createdAt": "1960-09-04T02:44:03.845Z",
  "updatedAt": "1994-11-09T08:23:43.715Z"
}

Modified at 2025-09-21 08:06:45

Exchange the Authorization Code for an Access Token.

Authenticate a user and generate an OAuth 2.0 Authorization Code Grant.