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

  1. HTTP-запрос
  2. Path-параметры
  3. Query-параметры
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 404
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля

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

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

HTTP-запрос

GET https://api360.yandex.net/directory/v1/org/{orgId}/groups\
?page={integer}\
&perPage={integer}

Path-параметры

orgId *

integer

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

orgId *

integer

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

Query-параметры

page

integer

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

perPage

integer

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

page

integer

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

perPage

integer

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

Ответы

Код 200

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

{
  "groups": [
    {
      "adminIds": [
        string
      ],
      "aliases": [
        string
      ],
      "authorId": string,
      "createdAt": string,
      "description": string,
      "email": string,
      "externalId": string,
      "id": integer,
      "label": string,
      "memberOf": [
        integer
      ],
      "members": [
        {
          "id": string,
          "type": string
        }
      ],
      "membersCount": integer,
      "name": string,
      "removed": boolean,
      "type": string
    }
  ],
  "page": integer,
  "pages": integer,
  "perPage": integer,
  "total": integer
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

groups[]

array

Список групп.

groups[].adminIds[]

array

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

groups[].aliases[]

array

Алиасы почтовых ящиков группы.

groups[].authorId

string

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

groups[].createdAt

string

Дата и время создания группы.

groups[].description

string

Описание группы.

groups[].email

string

Адрес почтовой рассылки группы.

groups[].externalId

string

Произвольный внешний идентификатор группы.

groups[].id

integer

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

groups[].label

string

Имя почтовой рассылки группы. Например, для адреса new-group@ваш-домен.ru имя почтовой рассылки — это new-group.

groups[].memberOf[]

array

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

groups[].members[]

array

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

groups[].members[].id

string

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

groups[].members[].type

string

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

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

Значение по умолчанию: user.

Возможные значения
  1. user
  2. group
  3. department

groups[].membersCount

integer

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

groups[].name

string

Название группы.

groups[].removed

boolean

Признак удаленной группы: true — группа удалена; false — группа действующая.

groups[].type

string

Тип группы.

page

integer

Номер страницы ответа.

pages

integer

Количество страниц ответа.

perPage

integer

Количество групп на одной странице ответа.

total

integer

Общее количество групп.

groups[]

array

Список групп.

groups[].adminIds[]

array

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

groups[].aliases[]

array

Алиасы почтовых ящиков группы.

groups[].authorId

string

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

groups[].createdAt

string

Дата и время создания группы.

groups[].description

string

Описание группы.

groups[].email

string

Адрес почтовой рассылки группы.

groups[].externalId

string

Произвольный внешний идентификатор группы.

groups[].id

integer

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

groups[].label

string

Имя почтовой рассылки группы. Например, для адреса new-group@ваш-домен.ru имя почтовой рассылки — это new-group.

groups[].memberOf[]

array

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

groups[].members[]

array

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

groups[].members[].id

string

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

groups[].members[].type

string

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

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

Значение по умолчанию: user.

Возможные значения
  1. user
  2. group
  3. department

groups[].membersCount

integer

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

groups[].name

string

Название группы.

groups[].removed

boolean

Признак удаленной группы: true — группа удалена; false — группа действующая.

groups[].type

string

Тип группы.

page

integer

Номер страницы ответа.

pages

integer

Количество страниц ответа.

perPage

integer

Количество групп на одной странице ответа.

total

integer

Общее количество групп.

Код 401

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 403

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 404

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 500

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string