Пользователи
Актуальную спецификацию можно скачать и использовать в привычном инструменте.
Перед началом работы
Для работы с API личного кабинета Cloud.ru потребуется:
-
эндпоинт для запросов — https://iam.api.cloud.ru;
-
customer_id — его можно скопировать в личном кабинете;
Если вы планируете назначать роли с помощью API, рекомендуем изучить статью Роли пользователей, в ней вы сможете найти описание для каждой роли.
Набор методов для управления пользователями
Список пользователей.
-
customerId (string) – Идентификатор пользователя.
-
email (string) – Адрес электронной почты пользователя. Поиск пользователей по частичному совпадению.
-
userName (string) – Имя пользователя. Поиск пользователей по частичному совпадению.
-
isFederative (boolean) – Флаг для фильтрации пользователей на федеративных и локальных.
-
limit (integer) – Количество записей на странице.
-
before (string) – Курсор для получения предыдущей страницы.
-
after (string) – Курсор для получения следующей страницы.
-
accountType (string) – Тип учетной записи пользователя: федеративная или локальная.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
500 Internal Server Error – Внутренняя ошибка сервера.
-
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) – ФИО пользователя.
Приглашение пользователя в организацию.
-
customerId (string) – Идентификатор организации, куда приглашается пользователь.
-
accountType (string) – Тип учетной записи пользователя.
-
email (string) – Электронная почта пользователя.
-
federative (boolean) – Флаг, что пользователь является федеративным, локальным или приглашенным.
-
firstName (string) – Имя пользователя.
-
idpId (string) – IDPID - необязательное поле для привязки пользователя к idp-клиента. Поддерживается только для федеративных пользователей.
-
lastName (string) – Фамилия пользователя.
-
middleName (string) – Отчество пользователя.
-
userName (string) – ФИО пользователя.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
404 Not Found – Ресурс не найден.
-
409 Conflict – Конфликт.
-
500 Internal Server Error – Внутренняя ошибка сервера.
-
userId (string) – Идентификатор созданного пользователя.
Поиск пользователя по электронной почте.
-
customerId (string) – Идентификатор организации.
-
email (string) – Адрес электронной почты пользователя.
-
type (string) – Тип учетной записи пользователя.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
404 Not Found – Ресурс не найден.
-
500 Internal Server Error – Внутренняя ошибка сервера.
-
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) – ФИО пользователя.
Повторное приглашение пользователя в организацию.
-
customerId (string) – Идентификатор организацииа, куда приглашается пользователь.
-
userId (string) – Идентификатор пользователя.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
404 Not Found – Ресурс не найден.
-
500 Internal Server Error – Внутренняя ошибка сервера.
Получение информации по пользователям организации.
-
customerId (string) – Идентификатор организации.
-
userId (string) – Идентификатор пользователя.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
404 Not Found – Ресурс не найден.
-
500 Internal Server Error – Внутренняя ошибка сервера.
-
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) – ФИО пользователя.
Удаление пользователя из организации.
-
customerId (string) – Идентификатор организации, из которой нужно удалить пользователя.
-
userId (string) – Идентификатор пользователя, которого нужно удалить.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
404 Not Found – Ресурс не найден.
-
500 Internal Server Error – Внутренняя ошибка сервера.
Обновление параметров пользователей. Обновление только федеративных пользователей.
-
customerId (string) – Идентификатор организации.
-
userId (string) – Идентификатор пользователя для обновления.
-
enabled (boolean) – Флаг блокировки/разблокировки пользователя.
-
firstName (string) – Имя пользователя.
-
lastName (string) – Фамилия пользователя.
-
middleName (string) – Отчество пользователя.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
404 Not Found – Ресурс не найден.
-
500 Internal Server Error – Внутренняя ошибка сервера.
-
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) – ФИО пользователя.
-
userId (string) –
-
newPassword (string) –
-
oldPassword (string) –
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
404 Not Found – Ресурс не найден.
-
500 Internal Server Error – Внутренняя ошибка сервера.
Получение списка разрешений с помощью фильтра.
-
resourceId (string) – Идентификатор ресурса.
-
customerId (string) – Идентификатор организации.
-
role (string) – Идентификатор роли.
-
subjectId (string) – Идентификатор субъекта.
-
subjectType (string) – Тип субъекта. Возможные значения: пользователь, группа пользователей, сервисный аккаунт.
-
limit (integer) – Количество записей на странице.
-
before (string) – Курсор для получения предыдущей страницы.
-
after (string) – Курсор для получения следующей страницы.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
500 Internal Server Error – Внутренняя ошибка сервера.
-
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) – Дата последнего изменения.
Удаление доступа.
-
id (object) – Идентификатор разрешения.
-
id.objectId (string) – Идентификатор объекта.
-
id.objectType (string) – Тип объекта. Возможные значения: организация, ресурс.
-
id.role (string) – Идентификатор роли.
-
id.subjectId (string) – Идентификатор субъекта.
-
id.subjectType (string) – Тип субъекта. Возможные значения: пользователь, группа пользователей, сервисный аккаунт.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
404 Not Found – Ресурс не найден.
-
500 Internal Server Error – Внутренняя ошибка сервера.
Добавление доступа.
-
expiresAt (string) – Дата окончания срока действия разрешения.
-
objectId (string) – Идентификатор объекта.
-
objectType (string) – Тип объекта. Возможные значения: организация, ресурс.
-
role (string) – Назначаемая роль.
-
subjectId (string) – Идентификатор субъекта.
-
subjectType (string) – Тип субъекта. Возможные значения: пользователь, группа пользователей, сервисный аккаунт.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
404 Not Found – Ресурс не найден.
-
500 Internal Server Error – Внутренняя ошибка сервера.
ListUsers list user’s that have permissions on project
-
projectId (string) –
-
email (string) – Электронная почта пользователя. Поиск пользователей по частичному совпадению.
-
userName (string) – Имя пользователя. Поиск пользователей по частичному совпадению.
-
limit (integer) – Количество записей на странице. При указании значения 0 будут возвращены все пользователи, удовлетворяющие запросу.
-
before (string) – Курсор для получения предыдущей страницы..
-
after (string) – Курсор для получения следующей страницы.
-
200 OK – Успешное выполнение запроса.
-
400 Bad Request – Некорректный запрос.
-
401 Unauthorized – Необходима авторизация.
-
403 Forbidden – Доступ запрещен.
-
500 Internal Server Error – Внутренняя ошибка сервера.
-
cursor (object) – Переход на предыдущую и следующую страницу.
-
cursor.after (string) – Курсор для получения следующей страницы.
-
cursor.before (string) – Курсор для получения предыдущей страницы.
-
limit (integer) – Количество записей на странице.
-
users (array) – Список пользователей проекта.
-
users[].email (string) – Электронная почта пользователя.
-
users[].id (string) – Идентификатор пользователя.
-
users[].userName (string) – Имя пользователя.
- Перед началом работы
- Набор методов для управления пользователями