Получить список сотрудников организации

Возвращает список сотрудников с возможностью поиска пользователя по адресу его электронной почты.

Примечание

Чтобы выполнить запрос, приложению требуется одно из разрешений:

directory:read_users — просмотр данных пользователей;
directory:write_users — просмотр и изменение данных пользователей.

Запрос

GET https://cloud-api.yandex.net/v1/directory/organizations/{org_id}/users

Path-параметры

Имя параметра	Тип	Описание
org_id *	integer	Идентификатор организации.

Query-параметры

Имя параметра	Тип	Описание
email	string	Адрес электронной почты, по которому будут отфильтрованы сотрудники.
limit	integer	Максимальное количество записей в ответе.
offset	integer	Смещение, с которого начинается выборка данных. Поддерживаются только значения `offset`, кратные значению `limit`.

Заголовки

Authorization: OAuth <токен>

Пример

Пример запроса

curl -X GET -H "Authorization: OAuth <токен>" https://cloud-api.yandex.net/v1/directory/organizations/123456/users

Ответ

Успешный ответ

Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится объект со списком сотрудников.

200 OK — запрос выполнен успешно.

Имя параметра	Тип	Описание
limit	integer	Максимальное количество записей в ответе.
offset	integer	Смещение, с которого начинается выборка данных.
total	integer	Общее количество записей, подходящих по параметрам запроса.
items	v1User[]	Список сотрудников, отфильтрованных по адресу электронной почты.

v1User

Поле	Тип	Описание
about	string	Описание сотрудника.
aliases	string[]	Список алиасов сотрудника.
avatar_id	string	Идентификатор аватара сотрудника.
birthday	string	Дата рождения сотрудника. Формат: `YYYY-MM-DD`. Может быть пустой строкой.
contacts	v1UserContact[]	Список контактов сотрудника.
created_at	string<date-time>	Дата и время создания сотрудника.
department_id	integer<int64>	Идентификатор подразделения сотрудника.
email	string	Основной адрес электронной почты.
external_id	string	Произвольный внешний идентификатор.
gender	string	Пол сотрудника.
groups	integer<int64>[]	Идентификаторы групп сотрудника.
id	string<uint64>	Идентификатор сотрудника.
is_2fa_enabled	boolean	Статус обязательной персональной двухфакторной аутентификации: `true` — включена; `false` — выключена.
is_admin	boolean	Признак администратора организации: `true` — администратор; `false` — рядовой пользователь.
is_dismissed	boolean	Статус сотрудника: `true` — уволенный; `false` — действующий.
is_enabled	boolean	Статус аккаунта: `true` — активен; `false` — заблокирован.
is_enabled_updated_at	string<date-time>	Дата и время последнего изменения статуса аккаунта. Отсутствует, если статус никогда не менялся.
is_robot	boolean	Признак служебного бота: `true` — бот; `false` — человек.
language	string	Язык сотрудника.
name	v1UserName	ФИО сотрудника.
nickname	string	Логин сотрудника.
position	string	Должность сотрудника.
timezone	string	Часовой пояс сотрудника.
updated_at	string<date-time>	Дата и время изменения данных сотрудника.

v1UserContact

Поле	Тип	Описание
alias	boolean	Признак алиаса: `true` — контакт создан на основе алиаса; `false` — контакт создан вручную.
label	string	Произвольная метка контакта.
main	boolean	Признак основного контакта: `true` — основной; `false` — альтернативный.
synthetic	boolean	Признак автоматически созданного контакта: `true` — контакт создан автоматически; `false` — контакт создан вручную.
type	string	Тип контакта.
value	string	Значение контакта.

v1UserName

Поле	Тип	Описание
first	string	Имя сотрудника.
middle	string	Отчество сотрудника.
last	string	Фамилия сотрудника.

Пример

Пример ответа

{
  "limit": 0,
  "offset": 0,
  "total": 0,
  "items": [
    {
      "id": 0,
      "nickname": "string",
      "department_id": 0,
      "email": "string",
      "name": {
        "first": "string",
        "middle": "string",
        "last": "string"
      },
      "gender": "string",
      "position": "string",
      "avatar_id": "string",
      "about": "string",
      "birthday": "string",
      "contacts": [
        {
          "type": "string",
          "value": "string",
          "main": true,
          "alias": true,
          "synthetic": true
        }
      ],
      "aliases": [
        "string"
      ],
      "external_id": "string",
      "is_admin": true,
      "is_robot": true,
      "is_dismissed": true,
      "is_2fa_enabled": true,
      "is_enabled": true,
      "timezone": "string",
      "language": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

Неуспешный ответ

Ошибки могут быть со следующими HTTP-статусами:

400 Bad Request — параметры запроса не заданы или заданы неверно;
401 Unauthorized — пользователь не авторизован;
403 Forbidden — у пользователя или приложения нет прав на доступ к списку пользователей;
404 Not Found — запрашиваемая организация не найдена;
500 Internal Server Error — ошибка произошла на стороне сервера (в этом случае попробуйте повторно отправить запрос через некоторое время).

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

Обзор

Получить список групп