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

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

Примечание

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

Request

GET

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

Path parameters

Name

Description

groupId*

Type: integer<int64>

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

orgId*

Type: integer<int64>

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

Responses

200 OK

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

Body

application/json

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

Name	Description
departments	Type: v1ShortDepartment[] Подразделения. Краткая информация о подразделении.
externalContacts	Type: v1ShortExternalContact[] Внешние контакты.
groups	Type: v1ShortGroup[] Группы. Краткая информация о группе.
sharedMailboxes	Type: v2ShortSharedMailbox[] Общие ящики.
users	Type: v1ShortUser[] Сотрудники. Краткая информация о сотруднике.

v1ShortDepartment

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

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

v1ShortExternalContact

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

v1ShortGroup

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

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

v2ShortSharedMailbox

Name

Description

Type: string<uint64>

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

name

Type: string

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

v1ShortUser

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

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

v1UserName

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

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

400 Bad Request

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

Body

application/json

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

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

protobufAny

Name	Description
@type	Type: string
...rest	Type: any

401 Unauthorized

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

Body

application/json

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

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

403 Forbidden

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

Body

application/json

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

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

404 Not Found

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

Body

application/json

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

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

500 Internal Server Error

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

Body

application/json

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

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

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

Обзор

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