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

Возвращает список групп с постраничной навигацией.

Примечание

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

Request

GET

https://api360.yandex.net/directory/v1/org/{orgId}/groups

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

Query parameters

Name

Description

page

Type: integer<int64>

Номер страницы ответа. Значение по умолчанию — 1.

perPage

Type: integer<int64>

Количество групп на одной странице ответа. Значение по умолчанию — 10.

Responses

200 OK

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

Body

application/json

{
    "groups": [
        {
            "id": 0,
            "name": "string",
            "type": "string",
            "description": "string",
            "membersCount": 0,
            "label": "string",
            "email": "string",
            "emailId": "string",
            "aliases": [
                "string"
            ],
            "externalId": "string",
            "removed": false,
            "members": [
                {
                    "type": "user",
                    "id": "string"
                }
            ],
            "memberOf": [
                0
            ],
            "createdAt": "2022-12-29T18:02:01Z"
        }
    ],
    "page": 0,
    "pages": 0,
    "perPage": 0,
    "total": 0
}

Name	Description
groups	Type: v1Group[] Список групп. Группа.
page	Type: integer<int64> Номер страницы ответа.
pages	Type: integer<int64> Количество страниц ответа.
perPage	Type: integer<int64> Количество групп на одной странице ответа.
total	Type: integer<int64> Общее количество групп.

v1Group

Группа.

Name	Description
aliases	Type: string[] Алиасы почтовых ящиков группы.
createdAt	Type: string<date-time> Дата и время создания группы.
description	Type: string Описание группы.
email	Type: string Адрес почтовой рассылки группы.
emailId	Type: string<uint64> Идентификатор почтовой рассылки группы.
externalId	Type: string Произвольный внешний идентификатор группы.
id	Type: integer<int64> Идентификатор группы.
label	Type: string Имя почтовой рассылки группы. Например, для адреса `new-group@ваш-домен.ru` имя почтовой рассылки — это `new-group`.
memberOf	Type: integer<int64>[] Идентификаторы групп, в которые входит эта группа.
members	Type: v1GroupMember[] Участники группы.
membersCount	Type: integer<int64> Количество участников группы.
name	Type: string Название группы.
removed	Type: boolean Признак удаленной группы: `true` — группа удалена; `false` — группа действующая.
type	Type: string Тип группы. Возможные значения: `generic` — стандартная группа, созданная одним из сотрудников организации. Пользователи могут изменять параметры такой группы и ее состав. `organization_admin` — Группа администраторов организации. Неизменяемая техническая группа. `robots` — Группа роботов. Неизменяемая техническая группа. `organization_deputy_admin` — Группа менеджеров организации. Неизменяемая техническая группа.

v1GroupMember

Name

Description

Type: string<uint64>

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

type

Type: GroupMemberGroupMemberType

Тип участника группы.

Default: user

Enum: user, group, department

GroupMemberGroupMemberType

Тип участника группы.

user: Сотрудник.
group: Группа.
department: Подразделение.

Type

Description

GroupMemberGroupMemberType

Default: user

Enum: user, group, department

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 Описание ошибки.

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

Обзор

Создать группу