tocdepth: 2

Просмотр групп

Пользователь может получить информацию по списку групп или по отдельной группе.

Посмотреть список групп

Чтобы посмотреть списки групп под организацией или конкретным проектом, выполните запрос, в котором укажите один из параметров:

target.customerId — идентификатор организации,

или

target.projectId — идентификатор поекта.

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

Где:

target.customerId — Идентификатор организации.
target.projectId — Идентификатор поекта.
limit — Количество записей в ответе. Если количество записей не указано, то лимит будет равен 1 000.
cursor.before — Получение предыдущей страницы групп.
cursor.after — Получение следующей страницы групп.

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

В теле ответа возвратится список групп или под организацией, или под проектом в соответствии с условими фильтра.

{
  "groups": [
      {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
        "name": "testGroupHVA",
        "description": "группа",
        "target": {
            "project_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx"
        },
        "created_at": "2024-09-03T09:11:01.717153Z",
        "updated_at": "2024-09-03T09:11:01.717153Z"
      }
  ],
  "limit": 10,
  "cursor": {
      "before": "",
      "after": ""
  }
}

Посмотреть конкретную группу

Получить информацию о группе можно по ее идентификатору.

curl --location 'https://iam.api.cloud.ru/api/v1/groups/<groupId>' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer ey***Aw'

Где:

groupId — идентификатор группы.

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

{
  "group": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
      "name": "testGroupHVA",
      "description": "группа",
      "target": {
          "project_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx"
      },
      "created_at": "2024-09-03T09:11:01.717153Z",
      "updated_at": "2024-09-03T09:11:01.717153Z"
  }
}

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