Skip to main content
PUT
/
api
/
users
/
{id}
Update PlatformUser
curl --request PUT \
  --url https://platform.kodexa.ai/api/users/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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>"
}
'
{
  "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>"
}

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json

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

active
boolean
bio
string
businessGroup
string
changeSequence
integer<int32>

Optimistic locking version number.

createdOn
string<date-time>

Timestamp when the user was created.

email
string
firstName
string
groupsJson
string
id
string

Unique identifier (UUID) for the user.

image
string
isExternallyManaged
boolean
lastName
string
preferences
object
roles
object
rolesJson
string
searchText
string
showDeveloperTools
boolean
title
string
updatedOn
string<date-time>

Timestamp when the user was last updated.

userStorage
object
userType
string
uuid
string

Secondary UUID identifier.

Response

Updated PlatformUser

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

active
boolean
bio
string
businessGroup
string
changeSequence
integer<int32>

Optimistic locking version number.

createdOn
string<date-time>

Timestamp when the user was created.

email
string
firstName
string
groupsJson
string
id
string

Unique identifier (UUID) for the user.

image
string
isExternallyManaged
boolean
lastName
string
preferences
object
roles
object
rolesJson
string
searchText
string
showDeveloperTools
boolean
title
string
updatedOn
string<date-time>

Timestamp when the user was last updated.

userStorage
object
userType
string
uuid
string

Secondary UUID identifier.