Breadcrumbs

Получение списка атрибутов пользователя

Метод используется для получения одностраничного списка атрибутов, применимых к текущему пользователю. Метод возвращает следующую информацию:

  1. Основные атрибуты пользователя.

  2. Публичные дополнительные атрибуты пользователя (см. ).

  3. Требования к формату значений атрибутов.

  4. Значения атрибутов для текущего пользователя.

GET {reseller_domain}/internal_api/user_attributes

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

Content-Type

header

string

Обязательный

Тип данных, передаваемых в запросе. Укажите application/vnd.api+json

Accept

header

string

Обязательный

Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json

X-Api-Locale

header

string

Опциональный

Двухбуквенный код языка данных в ответе

Authorization 

header

string

Обязательный

Действующий access token пользователя. Формат: Bearer <access token>

reseller_domain

path

string

Обязательный

Доменное имя реселлера

Модель ответа

Название

Тип данных

Описание

data

object

Данные ответа


id

string

ID текущего пользователя


type

string

Тип данных


attributes

object

Информация об атрибутах пользователя



base_attributes

array of objects

Список основных атрибутов пользователя




name

string

Название атрибута




key

string

Ключ атрибута




optional

bool

Признак необязательности атрибута:

  • true — атрибут необязательный.

  • false — атрибут обязательный.




type

string

Тип данных атрибута:

  • string — cтрока. Позволяет вводить любой набор символов в виде однострочного текста.

  • text — текст. Позволяет вводить любой набор символов в виде многострочного текста.

  • checkbox — логический тип. Отображается в виде флажка. 

  • date — дата. Позволяет выбирать дату из календаря.

  • password — пароль. Вводимые данные скрываются маской. 

  • list — список. Позволяет выбрать одно из предустановленных значений.

  • email.




available_values

array 

Список допустимых значений:

  • Для атрибутов типа checkbox:

    • true — флажок установлен.

    • false — флажок не установлен.

  • Для атрибутов типа list — список пар ключ-значение в виде объекта:

    • key — ключ допустимого значения.

    • name — допустимое значение.

  • Для атрибутов других типов пустой массив — нет предустановленных значений.




readonly

bool

Признак недоступности для изменения после создания пользователя:

  • true — атрибут недоступен для изменения.

  • false — атрибут доступен для изменения.




value

зависит от атрибута

Значение атрибута для текущего пользователя



custom_attributes

array of objects

Список публичных дополнительных атрибутов пользователя (см.

)




name

string

Название атрибута




key

string

Ключ атрибута




optional

bool

Признак необязательности атрибута:

  • true — атрибут необязательный.

  • false — атрибут обязательный.




type

string

Тип данных атрибута:

  • string — cтрока. Позволяет вводить любой набор символов в виде однострочного текста.

  • text — текст. Позволяет вводить любой набор символов в виде многострочного текста.

  • checkbox — логический тип. Отображается в виде флажка. 

  • date — дата. Позволяет выбирать дату из календаря.

  • password — пароль. Вводимые данные скрываются маской. 

  • list — список. Позволяет выбрать одно из предустановленных значений.




available_values

array

Список допустимых значений:

  • Для атрибутов типа checkbox:

    • true — флажок установлен.

    • false — флажок не установлен.

  • Для атрибутов типа list — список пар ключ-значение в виде объекта:

    Название

    Тип данных

    Описание

    key

    string

    Ключ допустимого значения

    name

    string

    Допустимое значение

  • Для атрибутов других типов пустой массив — нет предустановленных значений.




readonly

bool

Признак недоступности для изменения после создания пользователя:

  • true — атрибут недоступен для изменения.

  • false — атрибут доступен для изменения.




format

string

Регулярное выражение для контроля указываемых значений




priority

integer

Приоритет отображения на странице со списком атрибутов




category

object

Группа, к которой относится атрибут, в виде объекта:

Название

Тип данных

Описание

id

string

ID группы дополнительных атрибутов

name

string

Название группы дополнительных атрибутов




description

string

Описание атрибута для отображения в виде подсказки




value

зависит от атрибута

Значение атрибута для текущего пользователя

meta

object

Дополнительная информация


server_current_time

string

Текущие дата и время сервера

Пример запроса

Bash
curl --location --request GET 'https://test.activeplatform.com/internal_api/user_attributes' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

Пример ответа

JSON
{
    "data": {
        "id": "2477",
        "type": "user_attributes",
        "attributes": {
            "base_attributes": [
                {
                    "name": "First name",
                    "key": "first_name",
                    "optional": false,
                    "type": "string",
                    "available_values": [],
                    "readonly": false,
                    "value": "Kristopher"
                },
                {
                    "name": "Last name",
                    "key": "last_name",
                    "optional": false,
                    "type": "string",
                    "available_values": [],
                    "readonly": false,
                    "value": "Legros"
                },
                {
                    "name": "Middle name",
                    "key": "middle_name",
                    "optional": true,
                    "type": "string",
                    "available_values": [],
                    "readonly": false,
                    "value": "Herbert"
                },
                {
                    "name": "Email",
                    "key": "email",
                    "optional": false,
                    "type": "email",
                    "available_values": [],
                    "readonly": true,
                    "value": "user@example.com"
                }
            ],
            "custom_attributes": [
                {
                    "name": "String for User",
                    "key": "userstring",
                    "optional": true,
                    "type": "string",
                    "available_values": [],
                    "readonly": false,
                    "format": "",
                    "priority": 5,
                    "category": {
                        "id": "559",
                        "name": "Test Category"
                    },
                    "description": "Description example",
                    "value": null
                },
                {
                    "name": "Date for User",
                    "key": "userdate",
                    "optional": true,
                    "type": "date",
                    "available_values": [],
                    "readonly": false,
                    "format": "",
                    "priority": 0,
                    "category": null,
                    "description": "Description example",
                    "value": "2023-01-13"
                },
                {
                    "name": "List for User",
                    "key": "userlist",
                    "optional": true,
                    "type": "list",
                    "available_values": [
                        {
                            "key": "one",
                            "name": "First"
                        },
                        {
                            "key": "two",
                            "name": "Second"
                        }
                    ],
                    "readonly": false,
                    "format": null,
                    "priority": 3,
                    "category": null,
                    "description": "Description example",
                    "value": null
                },
                {
                    "name": "Checkbox for User",
                    "key": "usercheckbox",
                    "optional": true,
                    "type": "checkbox",
                    "available_values": [
                        true,
                        false
                    ],
                    "readonly": false,
                    "format": "",
                    "priority": 0,
                    "category": null,
                    "description": "Description example",
                    "value": false
                }
            ]
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}