Настройки и администрирование

Группы пользователей

Подсказка

Актуальную спецификацию можно скачать и использовать в привычном инструменте.

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

Для работы с API личного кабинета Cloud.ru потребуется:

эндпоинт для запросов — https://iam.api.cloud.ru;
авторизационный токен;
customer_id — его можно скопировать в личном кабинете;
сервисный аккаунт.

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

GET /api/v1/groups

Просмотр группы пользователей.

Query Parameters

target.customerId (string) – Идентификатор организации.
target.projectId (string) – Идентификатор проекта.
limit (integer) – Количество записей на странице.
cursor.before (string) – Курсор для получения предыдущей страницы.
cursor.after (string) – Курсор для получения следующей страницы.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
500 Internal Server Error – Внутренняя ошибка сервера.

Response JSON Object

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) – Количество записей на странице.

POST /api/v1/groups

Создание новой группы.

Request JSON Object

description (string) – Описание группы.
name (string) – Название группы.
target (object) – Объект, с которым нужно связать группу.
target.customerId (string) – Идентификатор организации.
target.projectId (string) – Идентификатор проекта.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
409 Conflict – Конфликт.
500 Internal Server Error – Внутренняя ошибка сервера.

Response JSON Object

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) – Дата обновления группы.

GET /api/v1/groups/{groupId}/users

Получение списка пользователей, которые являются членами группы.

Parameters

groupId (string) – Идентификатор группы.

Query Parameters

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

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

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/groups/{groupId}/users

Добавление пользователей в группу и удаление всех существующих членств.

Parameters

groupId (string) – Идентификатор группы.

Request JSON Object

userIds (array) – Идентификатор пользователя для добавления в группу.
userIds[] (string) –

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

GET /api/v1/groups/{groupId}/users/{userId}

Проверка, является ли пользователь членом группы.

Parameters

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

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

Response JSON Object

groupId (string) – Идентификатор группы.
isMember (boolean) – Проверка, является ли пользователь членом группы.
userId (string) – Идентификатор пользователя.

DELETE /api/v1/groups/{groupId}/users/{userId}

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

Parameters

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

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

POST /api/v1/groups/{groupId}/users/{userId}

Добавление пользователя в группу.

Parameters

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

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
409 Conflict – Конфликт.
500 Internal Server Error – Внутренняя ошибка сервера.

GET /api/v1/groups/{id}

Поиск группы по идентификатору.

Parameters

id (string) – Идентификатор группы.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

Response JSON Object

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) – Дата обновления группы.

DELETE /api/v1/groups/{id}

Удаление группы.

Parameters

id (string) – Идентификатор группы.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

PUT /api/v1/groups/{id}

Обновление группы.

Parameters

id (string) – Идентификатор группы.

Request JSON Object

description (string) – Описание группы.
name (string) – Название группы.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

Response JSON Object

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) – Дата обновления группы.

GET /api/v1/permissions

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

Query Parameters

resourceId (string) – Идентификатор ресурса.
customerId (string) – Идентификатор организации.
role (string) – Идентификатор роли.
subjectId (string) – Идентификатор субъекта.
subjectType (string) – Тип субъекта. Возможные значения: пользователь, группа пользователей, сервисный аккаунт.
limit (integer) – Количество записей на странице.
before (string) – Курсор для получения предыдущей страницы.
after (string) – Курсор для получения следующей страницы.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
500 Internal Server Error – Внутренняя ошибка сервера.

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

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

POST /api/v1/permissions

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

Request JSON Object

expiresAt (string) – Дата окончания срока действия разрешения.
objectId (string) – Идентификатор объекта.
objectType (string) – Тип объекта. Возможные значения: организация, ресурс.
role (string) – Назначаемая роль.
subjectId (string) – Идентификатор субъекта.
subjectType (string) – Тип субъекта. Возможные значения: пользователь, группа пользователей, сервисный аккаунт.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

Была ли эта статья полезна?

Поддержка Юридические документы