tocdepth

2

Управление пользователями

В разделе описаны методы для работы с пользователями.

Перед началом работы

Для работы с API потребуется:

Набор методов для управления пользователями

GET /api/v1/customers/{customerId}/users

Список пользователей.

Parameters

  • customerId (string) – Идентификатор пользователя.

Query Parameters

  • email (string) – Адрес электронной почты пользователя. Поиск пользователей по частичному совпадению.

  • userName (string) – Имя пользователя. Поиск пользователей по частичному совпадению.

  • isFederative (boolean) – Флаг для фильтрации пользователей на федеративных и локальных.

  • limit (integer) – Количество записей на странице.

  • before (string) – Курсор для получения предыдущей страницы.

  • after (string) – Курсор для получения следующей страницы.

  • accountType (string) – Тип учетной записи пользователя: федеративная или локальная.

Status Codes
Response JSON Object

  • cursor (object) – Разбивка записей по страницам.

  • cursor.after (string) – Курсор для получения следующей страницы.

  • cursor.before (string) – Курсор для получения предыдущей страницы.

  • limit (integer) – Количество записей на странице.

  • users (array) – Список пользователей проекта.

  • users[].accountType (string) – Тип учетной записи пользователя.

  • users[].email (string) – Электронная почта пользователя.

  • users[].enabled (boolean) – Флаг активности пользователя.

  • users[].firstName (string) – Имя пользователя.

  • users[].lastName (string) – Фамилия пользователя.

  • users[].middleName (string) – Отчество пользователя.

  • users[].userId (string) – Идентификатор пользователя.

  • users[].username (string) – ФИО пользователя.

POST /api/v1/customers/{customerId}/users

Приглашение пользователя в организацию.

Parameters

  • customerId (string) – Идентификатор организации, куда приглашается пользователь.

Request JSON Object

  • accountType (string) – Тип учетной записи пользователя.

  • email (string) – Электронная почта пользователя.

  • federative (boolean) – Флаг, что пользователь является федеративным, локальным или приглашенным.

  • firstName (string) – Имя пользователя.

  • idpId (string) – IDPID - необязательное поле для привязки пользователя к idp-клиента. Поддерживается только для федеративных пользователей.

  • lastName (string) – Фамилия пользователя.

  • middleName (string) – Отчество пользователя.

  • userName (string) – ФИО пользователя.

Status Codes
Response JSON Object

  • userId (string) – Идентификатор созданного пользователя.

GET /api/v1/customers/{customerId}/users/find

Поиск пользователя по электронной почте.

Parameters

  • customerId (string) – Идентификатор организации.

Query Parameters

  • email (string) – Адрес электронной почты пользователя.

  • type (string) – Тип учетной записи пользователя.

Status Codes
Response JSON Object

  • user (object) – Данные пользователя.

  • user.accountType (string) – Тип учетной записи пользователя.

  • user.email (string) – Электронная почта пользователя.

  • user.enabled (boolean) – Флаг активности пользователя.

  • user.firstName (string) – Имя пользователя.

  • user.lastName (string) – Фамилия пользователя.

  • user.middleName (string) – Отчество пользователя.

  • user.userId (string) – Идентификатор пользователя.

  • user.username (string) – ФИО пользователя.

POST /api/v1/customers/{customerId}/users/reinvite

Повторное приглашение пользователя в организацию.

Parameters

  • customerId (string) – Идентификатор организацииа, куда приглашается пользователь.

Request JSON Object

  • userId (string) – Идентификатор пользователя.

Status Codes
GET /api/v1/customers/{customerId}/users/{userId}

Получение информации по пользователям организации.

Parameters

  • customerId (string) – Идентификатор организации.

  • userId (string) – Идентификатор пользователя.

Status Codes
Response JSON Object

  • user (object) – Данные пользователя.

  • user.accountType (string) – Тип учетной записи пользователя.

  • user.email (string) – Электронная почта пользователя.

  • user.enabled (boolean) – Флаг активности пользователя.

  • user.firstName (string) – Имя пользователя.

  • user.lastName (string) – Фамилия пользователя.

  • user.middleName (string) – Отчество пользователя.

  • user.userId (string) – Идентификатор пользователя.

  • user.username (string) – ФИО пользователя.

DELETE /api/v1/customers/{customerId}/users/{userId}

Удаление пользователя из организации.

Parameters

  • customerId (string) – Идентификатор организации, из которой нужно удалить пользователя.

  • userId (string) – Идентификатор пользователя, которого нужно удалить.

Status Codes
PUT /api/v1/customers/{customerId}/users/{userId}

Обновление параметров пользователей. Обновление только федеративных пользователей.

Parameters

  • customerId (string) – Идентификатор организации.

  • userId (string) – Идентификатор пользователя для обновления.

Request JSON Object

  • enabled (boolean) – Флаг блокировки/разблокировки пользователя.

  • firstName (string) – Имя пользователя.

  • lastName (string) – Фамилия пользователя.

  • middleName (string) – Отчество пользователя.

Status Codes
Response JSON Object

  • user (object) – Данные пользователя.

  • user.accountType (string) – Тип учетной записи пользователя.

  • user.email (string) – Электронная почта пользователя.

  • user.enabled (boolean) – Флаг активности пользователя.

  • user.firstName (string) – Имя пользователя.

  • user.lastName (string) – Фамилия пользователя.

  • user.middleName (string) – Отчество пользователя.

  • user.userId (string) – Идентификатор пользователя.

  • user.username (string) – ФИО пользователя.

GET /api/v1/permissions

Получение списка разрешений с помощью фильтра.

Query Parameters

  • resourceId (string) – Идентификатор ресурса.

  • customerId (string) – Идентификатор организации.

  • role (string) – Идентификатор роли.

  • subjectId (string) – Идентификатор субъекта.

  • subjectType (string) – Тип субъекта. Возможные значения: пользователь, группа пользователей, сервисный аккаунт.

  • limit (integer) – Количество записей на странице.

  • before (string) – Курсор для получения предыдущей страницы.

  • after (string) – Курсор для получения следующей страницы.

Status Codes
Response JSON Object

  • after (string) – Курсор для получения следующей страницы.

  • before (string) – Курсор для получения предыдущей страницы.

  • limit (integer) – Количество записей на странице.

  • permissions (array) – Список разрешений.

  • permissions[].createdAt (string) – Дата создания.

  • permissions[].enabled (boolean) – Разрешение включено.

  • permissions[].expiresAt (string) – Дата окончания срока действия разрешения.

  • permissions[].objectId (string) – Идентификатор объекта.

  • permissions[].objectType (string) – Тип объекта. Возможные значения: организация, ресурс.

  • permissions[].role (string) – Идентификатор роли.

  • permissions[].subjectId (string) – Идентификатор субъекта.

  • permissions[].subjectType (string) – Тип субъекта. Возможные значения: пользователь, группа пользователей, сервисный аккаунт.

  • permissions[].updatedAt (string) – Дата последнего изменения.

DELETE /api/v1/permissions

Удаление доступа.

Request JSON Object

  • id (object) – Идентификатор разрешения.

  • id.objectId (string) – Идентификатор объекта.

  • id.objectType (string) – Тип объекта. Возможные значения: организация, ресурс.

  • id.role (string) – Идентификатор роли.

  • id.subjectId (string) – Идентификатор субъекта.

  • id.subjectType (string) – Тип субъекта. Возможные значения: пользователь, группа пользователей, сервисный аккаунт.

Status Codes
POST /api/v1/permissions

Добавление доступа.

Request JSON Object

  • expiresAt (string) – Дата окончания срока действия разрешения.

  • objectId (string) – Идентификатор объекта.

  • objectType (string) – Тип объекта. Возможные значения: организация, ресурс.

  • role (string) – Назначаемая роль.

  • subjectId (string) – Идентификатор субъекта.

  • subjectType (string) – Тип субъекта. Возможные значения: пользователь, группа пользователей, сервисный аккаунт.

Status Codes
GET /api/v1/projects/{projectId}/users

ListUsers list user’s that have permissions on project

Parameters

  • projectId (string) –

Query Parameters

  • email (string) – Электронная почта пользователя. Поиск пользователей по частичному совпадению.

  • userName (string) – Имя пользователя. Поиск пользователей по частичному совпадению.

  • limit (integer) – Количество записей на странице. При указании значения 0 будут возвращены все пользователи, удовлетворяющие запросу.

  • before (string) – Курсор для получения предыдущей страницы.

  • after (string) – Курсор для получения следующей страницы.

Status Codes
Response JSON Object

  • cursor (object) – Переход на предыдущую и следующую страницу.

  • cursor.after (string) – Курсор для получения следующей страницы.

  • cursor.before (string) – Курсор для получения предыдущей страницы.

  • limit (integer) – Количество записей на странице.

  • users (array) – Список пользователей проекта.

  • users[].email (string) – Электронная почта пользователя.

  • users[].id (string) – Идентификатор пользователя.

  • users[].userName (string) – Имя пользователя.

PUT /api/v1/users/{userId}/password
Parameters

  • userId (string) –

Request JSON Object

  • newPassword (string) –

  • oldPassword (string) –

Status Codes
Запустили Evolution free tier
для Dev & Test
Получить