External user properties

Table of Contents

Overview
Requests
Retrieving external user properties
Replacing external user properties
Changing external user properties

Overview

The external properties of the user are represented in the 'ext' field of the entity user.
Options that are not used by the server in system processes but can be used by applications, scripts, and product layer microservices are placed there.

Requests

HTTP verb Endpoint Description

HTTP verb	Endpoint	Description
`GET`	`/rest/v1/user/info`	Retrieving external user properties
`PUT`	`/rest/v1/user/info`	Replacing external user properties
`PATCH`	`/rest/v1/user/info`	Changing external user properties

GET

/rest/v1/user/info

Retrieving external user properties

PUT

/rest/v1/user/info

Replacing external user properties

PATCH

/rest/v1/user/info

Changing external user properties

For all requests:
Domain Type: any

Retrieving external user properties

Returns the contents of the 'ext' field of the user account, excluding the 'ct' and 'lwt'.

The contents are arbitrary.

Request

Request example

GET /rest/v1/user/ext HTTP/1.1

Response

Response example

HTTP/1.1 200 OK

{
  "eraAppearance": {
    "color": "",
    "mode": "advanced",
    "theme": "light"
  },
  "r21adminData": {
    "mode": "advanced",
    "theme": "light"
  }
}

Replacing external user properties

Completely replaces the contents of the 'ext' field of the user account.

The transferred content replaces the previous value in its entirety.

The value 'null' is not retained.

The 'ct' and 'lwt' keys are filtered out.

Request

Request example

PUT /rest/v1/user/ext HTTP/1.1
Content-Type: application/json

{
  "x" => "Test X",
  "y" => 2
}

Response

Response example

HTTP/1.1 200 OK

{
  "x": "Test X"
  "y": 2
}

Changing external user properties

Sets the contents of the 'ext' field of the user account.

The transferred content is merged with the previous value.
To add a value on a particular key, it is sufficient to pass only one of those keys in the content.

Key deletion is available by passing the value 'null' on the object key.

The 'ct' and 'lwt' keys are filtered out.

Request

Request example

PATCH /rest/v1/user/ext HTTP/1.1
Content-Type: application/json

{
  "x" => "Test"
}

Response

Response example

HTTP/1.1 200 OK

{
  "eraAppearance": {
    "color": "",
    "mode": "advanced",
    "theme": "light"
  },
  "r21adminData": {
    "mode": "advanced",
    "theme": "light"
  },
  "x": "Test"
}