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

[API] Изменение профиля авторизованного читателя

Обновление информации профиля авторизованного читателя.

PATCH users/{pr-login}

Авторизация

Этот запрос требует базовой авторизации.

Параметры запроса

Параметры пути
pr-login string
Логин авторизованного читателя, профиль которого необходимо обновить.
Параметры тела запроса
updatedFieldsstring
Разделенный запятыми список полей, которые подлежат обновлению. Если имя поля отсутствует в списке, то оно не будет обновлено, даже если значение поля указано в других параметрах запроса.
emailstring
[опционально] Электронная почта авторизованного читателя.
userRole
string
[опционально] Разделенный запятыми список групп доступа, к которым он относится авторизованный читатель.
isEnabled
bool
[опционально] Определяет, активна ли учетная запись или нет.

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request PATCH 'https://{portal-url}/api/v1/users/pr1' ^
--data-raw '{
"updatedFields": "email, userRole, isEnabled",
"email": "power-reader@company.co",
"userRole": "Group A",
"isEnabled": true,
}'