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

POST

/auth/oauth

The user system supports an OAuth 2.0 Authorization Code Grant. This call authenticates a user and generates an OAuth 2.0 Authorization Code Grant.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorised

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/auth/oauth' \
--header 'applicationId: string' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
  "username": "scotty",
  "password": "@$tr0ngP@$$",
  "directoryId": "2e214dec-bf44-4f58-83d0-2fa89d023e90"
}'

Response Example

200 - OK

{
  "valid": true,
  "code": "2b9d75b3ae36bdf3b66724b89996094ba724278784",
  "exp": 1559824668,
  "accountId": "ffe4f42e-7c1a-4ea3-9ec8-087d4a1071e6",
  "name": "Montgomery Christopher Jorgensen"
}

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

Check and validate an Oauth Access token.

Checks whether a user token is valid.