Skip to main content
POST
/
api
/
access-tokens
Create AccessToken
curl --request POST \
  --url https://platform.kodexa.ai/api/access-tokens \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<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>",
    "isExternallyManaged": true,
    "lastName": "<string>",
    "preferences": {
      "showOnboarding": true,
      "showScrollbars": true,
      "showWelcomeMessage": true
    },
    "roles": {
      "roles": [
        "<string>"
      ]
    },
    "rolesJson": "<string>",
    "searchText": "<string>",
    "showDeveloperTools": true,
    "title": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "userStorage": {
      "favoriteLinks": [
        {
          "link": "<string>"
        }
      ]
    },
    "userType": "<string>",
    "uuid": "<string>"
  },
  "userId": "<string>",
  "uuid": "<string>"
}
'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<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>",
    "isExternallyManaged": true,
    "lastName": "<string>",
    "preferences": {
      "showOnboarding": true,
      "showScrollbars": true,
      "showWelcomeMessage": true
    },
    "roles": {
      "roles": [
        "<string>"
      ]
    },
    "rolesJson": "<string>",
    "searchText": "<string>",
    "showDeveloperTools": true,
    "title": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "userStorage": {
      "favoriteLinks": [
        {
          "link": "<string>"
        }
      ]
    },
    "userType": "<string>",
    "uuid": "<string>"
  },
  "userId": "<string>",
  "uuid": "<string>"
}

Authorizations

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.

changeSequence
integer<int32>

Optimistic locking version number.

createdOn
string<date-time>

Timestamp when the access token was created.

expiresAt
string<date-time> | null
id
string

Unique identifier (UUID) for the access token.

name
string
updatedOn
string<date-time>

Timestamp when the access token was last updated.

user
object
userId
string | null
uuid
string

Secondary UUID identifier.

Response

Created AccessToken

An access token provides programmatic API authentication for a user.

changeSequence
integer<int32>

Optimistic locking version number.

createdOn
string<date-time>

Timestamp when the access token was created.

expiresAt
string<date-time> | null
id
string

Unique identifier (UUID) for the access token.

name
string
updatedOn
string<date-time>

Timestamp when the access token was last updated.

user
object
userId
string | null
uuid
string

Secondary UUID identifier.