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

Членство в группе

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

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

Выполните запрос:

curl --location 'https://iam.api.cloud.ru/api/v1/groups/<groupId>/users/<userId>' \
     --header 'accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <аутентификационный токен>' \
     --data '{}'

Где:

groupId — идентификатор группы, в которую добавляется пользователь;
userId — идентификатор пользователя, добавляемого в группу.

Исключение пользователя из группы

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

curl --location --request DELETE 'https://iam.api.cloud.ru/api/v1/groups/<groupId>/users/<userId>' \
     --header 'accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <аутентификационный токен>' \
     --data '{}'

Где:

groupId — идентификатор группы;
userId — идентификатор пользователя.

Коды ошибок

Включить в группу одних пользователей и исключить других

Включить в группу новых пользователей и исключить из нее всех текущих можно с помощью запроса:

curl --location 'https://iam.api.cloud.ru/api/v1/groups/<groupId>/users' \
     --header 'accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <аутентификационный токен>' \
     --data '{
       "userIds": [
         "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
         "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyyy",
       ]
     }'

Где:

groupId — идентификатор группы;
userIds — массив идентификаторов добавляемых в группу пользователей.

Проверить участие в группе

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

curl --location 'https://iam.api.cloud.ru/api/v1/groups/<groupId>/users/<userId>' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer <аутентификационный токен>'

Где:

groupId — идентификатор группы;
userId — идентификатор пользователя.

Пример ответа

Посмотреть всех участников группы

Чтобы посмотреть всех участников группы, выполните запрос:

curl --location 'https://iam.api.cloud.ru/api/v1/groups/<groupId>/users?limit=10' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer <аутентификационный токен>'

Где:

groupId — Идентификатор группы.
limit — Количество возвращаемых записей. Если лимит не задан, то по умолчанию вернется 1 000 записей.
before— Курсор для получения предыдущей страницы пользователей.
after — Курсор для получения следующей страницы пользователей.

Пример ответа

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

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