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,
  "email": "<string>",
  "firstName": "<string>",
  "groupsJson": "<string>",
  "image": "<string>",
  "invited": true,
  "isExternallyManaged": true,
  "lastName": "<string>",
  "preferences": {
    "showOnboarding": true,
    "showScrollbars": true,
    "showWelcomeMessage": true
  },
  "rolesJson": "<string>",
  "security": {
    "roles": [
      "<string>"
    ]
  },
  "showDeveloperTools": true,
  "title": "<string>",
  "userHash": "<string>",
  "userStorage": {
    "favoriteLinks": [
      {
        "link": "<string>"
      }
    ]
  },
  "userType": "<string>"
}
'

import requests

url = "https://platform.kodexa.ai/api/users/{id}"

payload = {
    "active": True,
    "bio": "<string>",
    "businessGroup": "<string>",
    "changeSequence": 123,
    "email": "<string>",
    "firstName": "<string>",
    "groupsJson": "<string>",
    "image": "<string>",
    "invited": True,
    "isExternallyManaged": True,
    "lastName": "<string>",
    "preferences": {
        "showOnboarding": True,
        "showScrollbars": True,
        "showWelcomeMessage": True
    },
    "rolesJson": "<string>",
    "security": { "roles": ["<string>"] },
    "showDeveloperTools": True,
    "title": "<string>",
    "userHash": "<string>",
    "userStorage": { "favoriteLinks": [{ "link": "<string>" }] },
    "userType": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    active: true,
    bio: '<string>',
    businessGroup: '<string>',
    changeSequence: 123,
    email: '<string>',
    firstName: '<string>',
    groupsJson: '<string>',
    image: '<string>',
    invited: true,
    isExternallyManaged: true,
    lastName: '<string>',
    preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
    rolesJson: '<string>',
    security: {roles: ['<string>']},
    showDeveloperTools: true,
    title: '<string>',
    userHash: '<string>',
    userStorage: {favoriteLinks: [{link: '<string>'}]},
    userType: '<string>'
  })
};

fetch('https://platform.kodexa.ai/api/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.kodexa.ai/api/users/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true,
    'bio' => '<string>',
    'businessGroup' => '<string>',
    'changeSequence' => 123,
    'email' => '<string>',
    'firstName' => '<string>',
    'groupsJson' => '<string>',
    'image' => '<string>',
    'invited' => true,
    'isExternallyManaged' => true,
    'lastName' => '<string>',
    'preferences' => [
        'showOnboarding' => true,
        'showScrollbars' => true,
        'showWelcomeMessage' => true
    ],
    'rolesJson' => '<string>',
    'security' => [
        'roles' => [
                '<string>'
        ]
    ],
    'showDeveloperTools' => true,
    'title' => '<string>',
    'userHash' => '<string>',
    'userStorage' => [
        'favoriteLinks' => [
                [
                                'link' => '<string>'
                ]
        ]
    ],
    'userType' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.kodexa.ai/api/users/{id}"

	payload := strings.NewReader("{\n  \"active\": true,\n  \"bio\": \"<string>\",\n  \"businessGroup\": \"<string>\",\n  \"changeSequence\": 123,\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"groupsJson\": \"<string>\",\n  \"image\": \"<string>\",\n  \"invited\": true,\n  \"isExternallyManaged\": true,\n  \"lastName\": \"<string>\",\n  \"preferences\": {\n    \"showOnboarding\": true,\n    \"showScrollbars\": true,\n    \"showWelcomeMessage\": true\n  },\n  \"rolesJson\": \"<string>\",\n  \"security\": {\n    \"roles\": [\n      \"<string>\"\n    ]\n  },\n  \"showDeveloperTools\": true,\n  \"title\": \"<string>\",\n  \"userHash\": \"<string>\",\n  \"userStorage\": {\n    \"favoriteLinks\": [\n      {\n        \"link\": \"<string>\"\n      }\n    ]\n  },\n  \"userType\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://platform.kodexa.ai/api/users/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"bio\": \"<string>\",\n  \"businessGroup\": \"<string>\",\n  \"changeSequence\": 123,\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"groupsJson\": \"<string>\",\n  \"image\": \"<string>\",\n  \"invited\": true,\n  \"isExternallyManaged\": true,\n  \"lastName\": \"<string>\",\n  \"preferences\": {\n    \"showOnboarding\": true,\n    \"showScrollbars\": true,\n    \"showWelcomeMessage\": true\n  },\n  \"rolesJson\": \"<string>\",\n  \"security\": {\n    \"roles\": [\n      \"<string>\"\n    ]\n  },\n  \"showDeveloperTools\": true,\n  \"title\": \"<string>\",\n  \"userHash\": \"<string>\",\n  \"userStorage\": {\n    \"favoriteLinks\": [\n      {\n        \"link\": \"<string>\"\n      }\n    ]\n  },\n  \"userType\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/users/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"active\": true,\n  \"bio\": \"<string>\",\n  \"businessGroup\": \"<string>\",\n  \"changeSequence\": 123,\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"groupsJson\": \"<string>\",\n  \"image\": \"<string>\",\n  \"invited\": true,\n  \"isExternallyManaged\": true,\n  \"lastName\": \"<string>\",\n  \"preferences\": {\n    \"showOnboarding\": true,\n    \"showScrollbars\": true,\n    \"showWelcomeMessage\": true\n  },\n  \"rolesJson\": \"<string>\",\n  \"security\": {\n    \"roles\": [\n      \"<string>\"\n    ]\n  },\n  \"showDeveloperTools\": true,\n  \"title\": \"<string>\",\n  \"userHash\": \"<string>\",\n  \"userStorage\": {\n    \"favoriteLinks\": [\n      {\n        \"link\": \"<string>\"\n      }\n    ]\n  },\n  \"userType\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
}

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,
  "email": "<string>",
  "firstName": "<string>",
  "groupsJson": "<string>",
  "image": "<string>",
  "invited": true,
  "isExternallyManaged": true,
  "lastName": "<string>",
  "preferences": {
    "showOnboarding": true,
    "showScrollbars": true,
    "showWelcomeMessage": true
  },
  "rolesJson": "<string>",
  "security": {
    "roles": [
      "<string>"
    ]
  },
  "showDeveloperTools": true,
  "title": "<string>",
  "userHash": "<string>",
  "userStorage": {
    "favoriteLinks": [
      {
        "link": "<string>"
      }
    ]
  },
  "userType": "<string>"
}
'

import requests

url = "https://platform.kodexa.ai/api/users/{id}"

payload = {
    "active": True,
    "bio": "<string>",
    "businessGroup": "<string>",
    "changeSequence": 123,
    "email": "<string>",
    "firstName": "<string>",
    "groupsJson": "<string>",
    "image": "<string>",
    "invited": True,
    "isExternallyManaged": True,
    "lastName": "<string>",
    "preferences": {
        "showOnboarding": True,
        "showScrollbars": True,
        "showWelcomeMessage": True
    },
    "rolesJson": "<string>",
    "security": { "roles": ["<string>"] },
    "showDeveloperTools": True,
    "title": "<string>",
    "userHash": "<string>",
    "userStorage": { "favoriteLinks": [{ "link": "<string>" }] },
    "userType": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    active: true,
    bio: '<string>',
    businessGroup: '<string>',
    changeSequence: 123,
    email: '<string>',
    firstName: '<string>',
    groupsJson: '<string>',
    image: '<string>',
    invited: true,
    isExternallyManaged: true,
    lastName: '<string>',
    preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
    rolesJson: '<string>',
    security: {roles: ['<string>']},
    showDeveloperTools: true,
    title: '<string>',
    userHash: '<string>',
    userStorage: {favoriteLinks: [{link: '<string>'}]},
    userType: '<string>'
  })
};

fetch('https://platform.kodexa.ai/api/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.kodexa.ai/api/users/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true,
    'bio' => '<string>',
    'businessGroup' => '<string>',
    'changeSequence' => 123,
    'email' => '<string>',
    'firstName' => '<string>',
    'groupsJson' => '<string>',
    'image' => '<string>',
    'invited' => true,
    'isExternallyManaged' => true,
    'lastName' => '<string>',
    'preferences' => [
        'showOnboarding' => true,
        'showScrollbars' => true,
        'showWelcomeMessage' => true
    ],
    'rolesJson' => '<string>',
    'security' => [
        'roles' => [
                '<string>'
        ]
    ],
    'showDeveloperTools' => true,
    'title' => '<string>',
    'userHash' => '<string>',
    'userStorage' => [
        'favoriteLinks' => [
                [
                                'link' => '<string>'
                ]
        ]
    ],
    'userType' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.kodexa.ai/api/users/{id}"

	payload := strings.NewReader("{\n  \"active\": true,\n  \"bio\": \"<string>\",\n  \"businessGroup\": \"<string>\",\n  \"changeSequence\": 123,\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"groupsJson\": \"<string>\",\n  \"image\": \"<string>\",\n  \"invited\": true,\n  \"isExternallyManaged\": true,\n  \"lastName\": \"<string>\",\n  \"preferences\": {\n    \"showOnboarding\": true,\n    \"showScrollbars\": true,\n    \"showWelcomeMessage\": true\n  },\n  \"rolesJson\": \"<string>\",\n  \"security\": {\n    \"roles\": [\n      \"<string>\"\n    ]\n  },\n  \"showDeveloperTools\": true,\n  \"title\": \"<string>\",\n  \"userHash\": \"<string>\",\n  \"userStorage\": {\n    \"favoriteLinks\": [\n      {\n        \"link\": \"<string>\"\n      }\n    ]\n  },\n  \"userType\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://platform.kodexa.ai/api/users/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"bio\": \"<string>\",\n  \"businessGroup\": \"<string>\",\n  \"changeSequence\": 123,\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"groupsJson\": \"<string>\",\n  \"image\": \"<string>\",\n  \"invited\": true,\n  \"isExternallyManaged\": true,\n  \"lastName\": \"<string>\",\n  \"preferences\": {\n    \"showOnboarding\": true,\n    \"showScrollbars\": true,\n    \"showWelcomeMessage\": true\n  },\n  \"rolesJson\": \"<string>\",\n  \"security\": {\n    \"roles\": [\n      \"<string>\"\n    ]\n  },\n  \"showDeveloperTools\": true,\n  \"title\": \"<string>\",\n  \"userHash\": \"<string>\",\n  \"userStorage\": {\n    \"favoriteLinks\": [\n      {\n        \"link\": \"<string>\"\n      }\n    ]\n  },\n  \"userType\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/users/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"active\": true,\n  \"bio\": \"<string>\",\n  \"businessGroup\": \"<string>\",\n  \"changeSequence\": 123,\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"groupsJson\": \"<string>\",\n  \"image\": \"<string>\",\n  \"invited\": true,\n  \"isExternallyManaged\": true,\n  \"lastName\": \"<string>\",\n  \"preferences\": {\n    \"showOnboarding\": true,\n    \"showScrollbars\": true,\n    \"showWelcomeMessage\": true\n  },\n  \"rolesJson\": \"<string>\",\n  \"security\": {\n    \"roles\": [\n      \"<string>\"\n    ]\n  },\n  \"showDeveloperTools\": true,\n  \"title\": \"<string>\",\n  \"userHash\": \"<string>\",\n  \"userStorage\": {\n    \"favoriteLinks\": [\n      {\n        \"link\": \"<string>\"\n      }\n    ]\n  },\n  \"userType\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
}

Authorizations

x-api-key

string

header

required

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

Path Parameters

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.

string

firstName

string

groupsJson

string

image

string

invited

boolean

isExternallyManaged

boolean

lastName

string

preferences

object

Show child attributes

rolesJson

string

security

object

Show child attributes

showDeveloperTools

boolean

title

string

userHash

string

userStorage

object

Show child attributes

userType

string

Response

Updated PlatformUser

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

active

boolean

required

bio

string

required

businessGroup

string

required

changeSequence

integer<int32>

required

Optimistic locking version number.

createdOn

string<date-time>

required

Timestamp when the user was created.

string

required

firstName

string

required

groupsJson

string

required

string

required

Unique identifier (UUID) for the user.

image

string

required

invited

boolean

required

isExternallyManaged

boolean

required

lastName

string

required

preferences

object

required

Show child attributes

rolesJson

string

required

searchText

string

required

security

object

required

Show child attributes

showDeveloperTools

boolean

required

title

string

required

updatedOn

string<date-time>

required

Timestamp when the user was last updated.

userHash

string

required

userStorage

object

required

Show child attributes

userType

string

required

uuid

string

required

Secondary UUID identifier.