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

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

Примечание

Требуется разрешение на чтение данных о группах.

Request

GET

https://api360.yandex.net/directory/v2/org/{orgId}/groups/{groupId}/members

Path parameters

Name

Description

groupId

Type: integer

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

orgId

Type: integer

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

Responses

200 OK

Запрос успешно выполнен.

Body

application/json

{
  "departments": [
    {
      "id": 0,
      "name": "example",
      "membersCount": 0
    }
  ],
  "groups": [
    {
      "id": 0,
      "name": "example",
      "membersCount": 0
    }
  ],
  "users": [
    {
      "id": "example",
      "nickname": "example",
      "departmentId": 0,
      "email": "example",
      "name": {
        "first": "example",
        "last": "example",
        "middle": "example"
      },
      "gender": "example",
      "position": "example",
      "avatarId": "example"
    }
  ],
  "externalContacts": [
    {
      "id": "example",
      "firstName": "example",
      "lastName": "example",
      "middleName": "example"
    }
  ],
  "sharedMailboxes": [
    {
      "id": "example",
      "name": "example"
    }
  ]
}

Name	Description
departments	Type: v1ShortDepartment[] Подразделения. Example `[ { "id": 0, "name": "example", "membersCount": 0 } ]`
externalContacts	Type: v1ShortExternalContact[] Внешние контакты. Example `[ { "id": "example", "firstName": "example", "lastName": "example", "middleName": "example" } ]`
groups	Type: v1ShortGroup[] Группы. Example `[ { "id": 0, "name": "example", "membersCount": 0 } ]`
sharedMailboxes	Type: v2ShortSharedMailbox[] Общие ящики. Example `[ { "id": "example", "name": "example" } ]`
users	Type: v1ShortUser[] Сотрудники. Example `[ { "id": "example", "nickname": "example", "departmentId": 0, "email": "example", "name": { "first": "example", "last": "example", "middle": "example" }, "gender": "example", "position": "example", "avatarId": "example" } ]`

v1ShortDepartment

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

Name	Description
id	Type: integer Идентификатор подразделения.
membersCount	Type: integer Количество сотрудников подразделения с учетом вложенных подразделений.
name	Type: string Название подразделения. Example: `example`

Example

{
  "id": 0,
  "name": "example",
  "membersCount": 0
}

v1ShortGroup

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

Name	Description
id	Type: integer Идентификатор группы.
membersCount	Type: integer Количество участников группы.
name	Type: string Название группы. Example: `example`

Example

{
  "id": 0,
  "name": "example",
  "membersCount": 0
}

v1UserName

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

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

Example

{
  "first": "example",
  "last": "example",
  "middle": "example"
}

v1ShortUser

Краткая информация о сотруднике.

Name	Description
avatarId	Type: string Идентификатор портрета сотрудника. Example: `example`
departmentId	Type: integer Идентификатор подразделения, в котором состоит сотрудник.
email	Type: string Основной адрес электронной почты сотрудника. Example: `example`
gender	Type: string Пол сотрудника. Example: `example`
id	Type: string<uint64> Идентификатор сотрудника. Example: `example`
name	Type: v1UserName ФИО сотрудника. Example `{ "first": "example", "last": "example", "middle": "example" }`
nickname	Type: string Логин сотрудника. Example: `example`
position	Type: string Должность сотрудника. Example: `example`

Example

{
  "id": "example",
  "nickname": "example",
  "departmentId": 0,
  "email": "example",
  "name": {
    "first": "example",
    "last": "example",
    "middle": "example"
  },
  "gender": "example",
  "position": "example",
  "avatarId": "example"
}

v1ShortExternalContact

Name	Description
firstName	Type: string Имя. Example: `example`
id	Type: string Идентификатор контакта. Example: `example`
lastName	Type: string Фамилия. Example: `example`
middleName	Type: string Отчество. Example: `example`

Example

{
  "id": "example",
  "firstName": "example",
  "lastName": "example",
  "middleName": "example"
}

v2ShortSharedMailbox

Name

Description

Type: string<uint64>

Идентификатор (resourceId) общего ящика.

Example: example

name

Type: string

Имя общего ящика.

Example: example

Example

{
  "id": "example",
  "name": "example"
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

Пользователь не авторизован.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

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

Обзор

Добавить участников в группу