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

Возвращает список участников группы, таких как сотрудники, подразделения или другие группы.

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

Для выполнения запроса требуется одно из перечисленных прав: directory:read_groups или directory:write_groups.

Request

GET

https://cloud-api.yandex.net/v1/api360/directory/org/{org_id}/groups/{group_id}/members

Path parameters

Name

Description

group_id

Type: string

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

Example: 7654321

org_id

Type: string

Идентификатор организации.

Example: 1234567

Responses

200 OK

Список участников группы получен.

Body

application/json

{
  "departments": [
    {
      "id": 2345678,
      "name": "Отдел разработки",
      "defaultEmail": "development@example.com"
    }
  ],
  "groups": [
    {
      "id": 7654321,
      "name": "Команда разработки",
      "defaultEmail": "development-team@example.com",
      "membersCount": 12
    }
  ],
  "users": [
    {
      "avatarId": "1234567890abcdef",
      "departmentId": 2345678,
      "email": "employee@example.com",
      "defaultEmail": "employee@example.com",
      "gender": "male",
      "id": "3456789",
      "name": {
        "first": "Иван",
        "middle": "Иванович",
        "last": "Иванов"
      },
      "nickname": "employee",
      "position": "Специалист"
    }
  ]
}

Name	Description
departments	Type: Departments Подразделения. Example `[ { "id": 2345678, "name": "Отдел разработки", "defaultEmail": "development@example.com" } ]`
groups	Type: Groups Группы. Example `[ { "id": 7654321, "name": "Команда разработки", "defaultEmail": "development-team@example.com", "membersCount": 12 } ]`
users	Type: Users Сотрудники. Example `[ { "avatarId": "1234567890abcdef", "departmentId": 2345678, "email": "employee@example.com", "defaultEmail": "employee@example.com", "gender": "male", "id": "3456789", "name": { "first": "Иван", "middle": "Иванович", "last": "Иванов" }, "nickname": "employee", "position": "Специалист" } ]`

DepartmentItem

Краткая информация о подразделении.

Name	Description
defaultEmail	Type: string Адрес, используемый по умолчанию. Example: `development@example.com`
id	Type: integer Идентификатор подразделения.
name	Type: string Название подразделения. Example: `Отдел разработки`

Example

{
  "id": 2345678,
  "name": "Отдел разработки",
  "defaultEmail": "development@example.com"
}

Departments

Подразделения.

Type: DepartmentItem[]

Example

[
  {
    "id": 2345678,
    "name": "Отдел разработки",
    "defaultEmail": "development@example.com"
  }
]

GroupItem

Краткая информация о группе.

Name	Description
defaultEmail	Type: string Адрес, используемый по умолчанию. Example: `development-team@example.com`
id	Type: integer Идентификатор группы.
membersCount	Type: integer Количество участников группы.
name	Type: string Название группы. Example: `Команда разработки`

Example

{
  "id": 7654321,
  "name": "Команда разработки",
  "defaultEmail": "development-team@example.com",
  "membersCount": 12
}

Groups

Группы.

Type: GroupItem[]

Example

[
  {
    "id": 7654321,
    "name": "Команда разработки",
    "defaultEmail": "development-team@example.com",
    "membersCount": 12
  }
]

Name

ФИО сотрудника.

Name	Description
first	Type: string Имя сотрудника. Example: `Иван`
last	Type: string Фамилия сотрудника. Example: `Иванов`
middle	Type: string Отчество сотрудника. Example: `Иванович`

Example

{
  "first": "Иван",
  "middle": "Иванович",
  "last": "Иванов"
}

UserItem

Краткая информация о пользователе.

Name	Description
avatarId	Type: string Идентификатор аватара сотрудника. Example: `1234567890abcdef`
defaultEmail	Type: string Адрес, используемый по умолчанию для отправки писем и отображения в контактах. Example: `employee@example.com`
departmentId	Type: integer Идентификатор подразделения, в котором состоит сотрудник.
email	Type: string Адрес электронной почты пользователя. Example: `employee@example.com`
gender	Type: string Пол сотрудника. Example: `male`
id	Type: string Идентификатор пользователя. Example: `3456789`
name	Type: Name ФИО сотрудника. Example `{ "first": "Иван", "middle": "Иванович", "last": "Иванов" }`
nickname	Type: string Логин пользователя. Example: `employee`
position	Type: string Должность сотрудника. Example: `Специалист`

Example

{
  "avatarId": "1234567890abcdef",
  "departmentId": 2345678,
  "email": "employee@example.com",
  "defaultEmail": "employee@example.com",
  "gender": "male",
  "id": "3456789",
  "name": {
    "first": "Иван",
    "middle": "Иванович",
    "last": "Иванов"
  },
  "nickname": "employee",
  "position": "Специалист"
}

Users

Сотрудники.

Type: UserItem[]

Example

[
  {
    "avatarId": "1234567890abcdef",
    "departmentId": 2345678,
    "email": "employee@example.com",
    "defaultEmail": "employee@example.com",
    "gender": "male",
    "id": "3456789",
    "name": {
      "first": "Иван",
      "middle": "Иванович",
      "last": "Иванов"
    },
    "nickname": "employee",
    "position": "Специалист"
  }
]

400 Bad Request

Неверные параметры запроса

Body

application/json

{
  "error": "invalid_argument",
  "description": "Неверные параметры запроса",
  "message": "Неверные параметры запроса",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Неверные параметры запроса

error

Type: string

Код ошибки

Example: invalid_argument

message

Type: string

Сообщение об ошибке.

Example: Неверные параметры запроса

details

Type: object

Дополнительные детали ошибки

Example

{}

403 Forbidden

Доступ запрещен

Body

application/json

{
  "error": "permission_denied",
  "description": "Доступ запрещен",
  "message": "Доступ запрещен",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Доступ запрещен

error

Type: string

Код ошибки

Example: permission_denied

message

Type: string

Сообщение об ошибке.

Example: Доступ запрещен

details

Type: object

Дополнительные детали ошибки

Example

{}

404 Not Found

Ресурс не найден

Body

application/json

{
  "error": "not_found",
  "description": "Ресурс не найден",
  "message": "Ресурс не найден",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Ресурс не найден

error

Type: string

Код ошибки

Example: not_found

message

Type: string

Сообщение об ошибке.

Example: Ресурс не найден

details

Type: object

Дополнительные детали ошибки

Example

{}

409 Conflict

Конфликт - ресурс уже существует

Body

application/json

{
  "error": "already_exists",
  "description": "Конфликт - ресурс уже существует",
  "message": "Конфликт - ресурс уже существует",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Конфликт - ресурс уже существует

error

Type: string

Код ошибки

Example: already_exists

message

Type: string

Сообщение об ошибке.

Example: Конфликт - ресурс уже существует

details

Type: object

Дополнительные детали ошибки

Example

{}

412 Precondition Failed

Функция недоступна или не оплачена

Body

application/json

{
  "error": "failed_precondition",
  "description": "Функция недоступна или не оплачена",
  "message": "Функция недоступна или не оплачена",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Функция недоступна или не оплачена

error

Type: string

Код ошибки

Example: failed_precondition

message

Type: string

Сообщение об ошибке.

Example: Функция недоступна или не оплачена

details

Type: object

Дополнительные детали ошибки

Example

{}

429 Too Many Requests

Превышен лимит запросов

Body

application/json

{
  "error": "resource_exhausted",
  "description": "Превышен лимит запросов",
  "message": "Превышен лимит запросов",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Превышен лимит запросов

error

Type: string

Код ошибки

Example: resource_exhausted

message

Type: string

Сообщение об ошибке.

Example: Превышен лимит запросов

details

Type: object

Дополнительные детали ошибки

Example

{}

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

Удалить контактную информацию

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