Просмотреть список групп
Возвращает список групп с постраничной навигацией.
Примечание
Требуется разрешение на чтение данных о группах.
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> Номер страницы ответа. Значение по умолчанию — |
|
perPage |
Type: integer<int64> Количество групп на одной странице ответа. Значение по умолчанию — |
Responses
200 OK
Запрос успешно выполнен.
Body
application/json
{
"groups": [
{
"id": 0,
"name": "string",
"type": "string",
"description": "string",
"membersCount": 0,
"label": "string",
"email": "string",
"aliases": [
"string"
],
"externalId": "string",
"removed": false,
"members": [
{
"type": "user",
"id": "string"
}
],
"adminIds": [
"string"
],
"authorId": "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 |
|
adminIds |
Type: string<uint64>[] Идентификаторы руководетелей группы. |
|
aliases |
Type: string[] Алиасы почтовых ящиков группы. |
|
authorId |
Type: string<uint64> Идентификатор создателя группы. |
|
createdAt |
Type: string<date-time> Дата и время создания группы. |
|
description |
Type: string Описание группы. |
|
|
Type: string Адрес почтовой рассылки группы. |
|
externalId |
Type: string Произвольный внешний идентификатор группы. |
|
id |
Type: integer<int64> Идентификатор группы. |
|
label |
Type: string Имя почтовой рассылки группы. Например, для адреса |
|
memberOf |
Type: integer<int64>[] Идентификаторы групп, в которые входит эта группа. |
|
members |
Type: v1GroupMember[] Участники группы. |
|
membersCount |
Type: integer<int64> Количество участников группы. |
|
name |
Type: string Название группы. |
|
removed |
Type: boolean Признак удаленной группы: |
|
type |
Type: string Тип группы. |
v1GroupMember
|
Name |
Description |
|
id |
Type: string<uint64> Идентификатор участника группы. |
|
type |
Type: GroupMemberGroupMemberType Тип участника группы.
Default: Enum: |
GroupMemberGroupMemberType
Тип участника группы.
- user: Сотрудник.
- group: Группа.
- department: Подразделение.
|
Type |
Description |
|
Default: Enum: |
401 Unauthorized
Пользователь не авторизован.
Body
application/json
{
"code": 0,
"message": "string",
"details": [
null
]
}
|
Name |
Description |
|
code |
Type: integer<int32> Код ошибки. |
|
details |
Type: any[] Дополнительные сведения об ошибке. |
|
message |
Type: string Описание ошибки. |
403 Forbidden
У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
Body
application/json
{
"code": 0,
"message": "string",
"details": [
null
]
}
|
Name |
Description |
|
code |
Type: integer<int32> Код ошибки. |
|
details |
Type: any[] Дополнительные сведения об ошибке. |
|
message |
Type: string Описание ошибки. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"code": 0,
"message": "string",
"details": [
null
]
}
|
Name |
Description |
|
code |
Type: integer<int32> Код ошибки. |
|
details |
Type: any[] Дополнительные сведения об ошибке. |
|
message |
Type: string Описание ошибки. |
500 Internal Server Error
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
Body
application/json
{
"code": 0,
"message": "string",
"details": [
null
]
}
|
Name |
Description |
|
code |
Type: integer<int32> Код ошибки. |
|
details |
Type: any[] Дополнительные сведения об ошибке. |
|
message |
Type: string Описание ошибки. |