Группы пользователей
Актуальную спецификацию можно скачать и использовать в привычном инструменте.
Перед началом работы
Для работы с API личного кабинета Cloud.ru потребуется:
эндпоинт для запросов — https://iam.api.cloud.ru;
customer_id — его можно скопировать в личном кабинете;
Набор методов для управления группами пользователей
Просмотр группы пользователей.
target.customerId (string) – Идентификатор организации.
target.projectId (string) – Идентификатор проекта.
limit (integer) – Количество записей на странице.
cursor.before (string) – Курсор для получения предыдущей страницы.
cursor.after (string) – Курсор для получения следующей страницы.
200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
500 Internal Server Error – Внутренняя ошибка сервера.
cursor (object) – Разбивка записей по страницам.
cursor.after (string) – Курсор для получения следующей страницы.
cursor.before (string) – Курсор для получения предыдущей страницы.
groups (array) – Список найденных групп.
groups[].createdAt (string) – Дата создания группы.
groups[].description (string) – Описание группы.
groups[].id (string) – Идентификатор группы.
groups[].name (string) – Название группы.
groups[].target (object) – Объект, с которым нужно связать группу.
groups[].target.customerId (string) – Идентификатор организации.
groups[].target.projectId (string) – Идентификатор проекта.
groups[].updatedAt (string) – Дата обновления группы.
limit (integer) – Количество записей на странице.
Создание новой группы.
description (string) – Описание группы.
name (string) – Название группы.
target (object) – Объект, с которым нужно связать группу.
target.customerId (string) – Идентификатор организации.
target.projectId (string) – Идентификатор проекта.
200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
409 Conflict – Конфликт.
500 Internal Server Error – Внутренняя ошибка сервера.
group (object) – Объект группы.
group.createdAt (string) – Дата создания группы.
group.description (string) – Описание группы.
group.id (string) – Идентификатор группы.
group.name (string) – Название группы.
group.target (object) – Объект, с которым нужно связать группу.
group.target.customerId (string) – Идентификатор организации.
group.target.projectId (string) – Идентификатор проекта.
group.updatedAt (string) – Дата обновления группы.
Получение списка пользователей, которые являются членами группы.
groupId (string) – Идентификатор группы.
limit (integer) – Количество записей на странице.
cursor.before (string) – Курсор для получения предыдущей страницы.
cursor.after (string) – Курсор для получения следующей страницы.
200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
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) – ФИО пользователя.
Добавление пользователей в группу и удаление всех существующих членств.
groupId (string) – Идентификатор группы.
userIds (array) – Идентификатор пользователя для добавления в группу.
userIds[] (string) –
200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.
Проверка, является ли пользователь членом группы.
groupId (string) – Идентификатор группы.
userId (string) – Идентификатор пользователя.
200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.
groupId (string) – Идентификатор группы.
isMember (boolean) – Проверка, является ли пользователь членом группы.
userId (string) – Идентификатор пользователя.
Удаление пользователя из группы.
groupId (string) – Идентификатор группы.
userId (string) – Идентификатор пользователя.
200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.
Добавление пользователя в группу.
groupId (string) – Идентификатор группы.
userId (string) – Идентификатор пользователя.
200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
409 Conflict – Конфликт.
500 Internal Server Error – Внутренняя ошибка сервера.
Поиск группы по идентификатору.
id (string) – Идентификатор группы.
200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.
group (object) – Объект группы.
group.createdAt (string) – Дата создания группы.
group.description (string) – Описание группы.
group.id (string) – Идентификатор группы.
group.name (string) – Название группы.
group.target (object) – Объект, с которым нужно связать группу.
group.target.customerId (string) – Идентификатор организации.
group.target.projectId (string) – Идентификатор проекта.
group.updatedAt (string) – Дата обновления группы.
Удаление группы.
id (string) – Идентификатор группы.
200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.
Обновление группы.
id (string) – Идентификатор группы.
description (string) – Описание группы.
name (string) – Название группы.
200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.
group (object) – Объект группы.
group.createdAt (string) – Дата создания группы.
group.description (string) – Описание группы.
group.id (string) – Идентификатор группы.
group.name (string) – Название группы.
group.target (object) – Объект, с которым нужно связать группу.
group.target.customerId (string) – Идентификатор организации.
group.target.projectId (string) – Идентификатор проекта.
group.updatedAt (string) – Дата обновления группы.
Получение списка разрешений с помощью фильтра.
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 – Внутренняя ошибка сервера.
- Перед началом работы
- Набор методов для управления группами пользователей