Create AccessToken

Creates a new AccessToken. Access tokens provide programmatic API authentication.

POST /api/access-tokens

Create AccessToken

cURL

curl --request POST \
  --url https://platform.kodexa.ai/api/access-tokens \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "intakeId": "<string>",
  "scope": "<string>",
  "tokenHint": "<string>",
  "user": {
    "active": true,
    "bio": "<string>",
    "businessGroup": "<string>",
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "firstName": "<string>",
    "groupsJson": "<string>",
    "id": "<string>",
    "image": "<string>",
    "invited": true,
    "isExternallyManaged": true,
    "lastName": "<string>",
    "preferences": {
      "showOnboarding": true,
      "showScrollbars": true,
      "showWelcomeMessage": true
    },
    "rolesJson": "<string>",
    "searchText": "<string>",
    "security": {
      "roles": [
        "<string>"
      ]
    },
    "showDeveloperTools": true,
    "title": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "userHash": "<string>",
    "userStorage": {
      "favoriteLinks": [
        {
          "link": "<string>"
        }
      ]
    },
    "userType": "<string>",
    "uuid": "<string>"
  },
  "userId": "<string>"
}
'

201

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "intakeId": "<string>",
  "name": "<string>",
  "scope": "<string>",
  "tokenHint": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "user": {
    "active": true,
    "bio": "<string>",
    "businessGroup": "<string>",
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "firstName": "<string>",
    "groupsJson": "<string>",
    "id": "<string>",
    "image": "<string>",
    "invited": true,
    "isExternallyManaged": true,
    "lastName": "<string>",
    "preferences": {
      "showOnboarding": true,
      "showScrollbars": true,
      "showWelcomeMessage": true
    },
    "rolesJson": "<string>",
    "searchText": "<string>",
    "security": {
      "roles": [
        "<string>"
      ]
    },
    "showDeveloperTools": true,
    "title": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "userHash": "<string>",
    "userStorage": {
      "favoriteLinks": [
        {
          "link": "<string>"
        }
      ]
    },
    "userType": "<string>",
    "uuid": "<string>"
  },
  "userId": "<string>",
  "uuid": "<string>"
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Body

application/json

An access token provides programmatic API authentication for a user.

name · string · required

expiresAt · string<date-time> | null

intakeId · string | null

scope · string | null

tokenHint · string

user · object | null

A platform user represents a user account in the Kodexa platform.

Show child attributes

userId · string | null

Response

201

application/json

Created AccessToken

An access token provides programmatic API authentication for a user.

changeSequence · integer<int32> · required

Optimistic locking version number.

createdOn · string<date-time> · required

Timestamp when the access token was created.

expiresAt · string<date-time> | null · required

id · string · required

Unique identifier (UUID) for the access token.

intakeId · string | null · required

name · string · required

scope · string | null · required

tokenHint · string · required

updatedOn · string<date-time> · required

Timestamp when the access token was last updated.

user · object | null · required

A platform user represents a user account in the Kodexa platform.

Show child attributes

userId · string | null · required

uuid · string · required

Secondary UUID identifier.