Просмотреть профиль сотрудника

Внимание. Сервис Яндекс Коннект больше не поддерживается. Directory API прекратит работу с 1 апреля 2023 года. С 24 марта доступность сервиса будет ограничена.

Для управления организациями, пользователями и доменами используйте сервис Яндекс 360 для бизнеса.

Документация API 360

Запрос позволяет получить информацию об определенном сотруднике. Вы можете запросить как полную информацию о сотруднике, так и только необходимые вам поля.

Ограничение. Чтобы выполнить запрос, вашему приложению требуется разрешение на чтение данных о сотрудниках. Убедитесь, что вы указали его при настройке OAuth.

Формат запроса

Чтобы запросить информацию о сотруднике, используйте HTTP-запрос с методом GET:

GET /v6/users/<user_id>/
fields=<параметр1>,<параметр2>, ...
Host: https://api.directory.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
Accept: application/json
Ресурс
<user_id>

Идентификатор сотрудника.

Тип данных: целое число.

Заголовки запроса
Host

Адрес узла, предоставляющего API:

https://api.directory.yandex.net
Authorization

OAuth-токен в формате OAuth <значение токена>, например:

OAuth 0c4181a7c2cf4521964a72ff57a34a07
X-Org-ID

Идентификатор организации. Заголовок необходимо передавать только если запрос выполняется от имени администратора нескольких организаций.

Accept

Допустимый формат ответа. Должен иметь значение application/json.

Параметры запроса
fields

Список полей сотрудника, которые вы хотите получить. Подробнее о доступных параметрах сотрудников читайте в разделе Формат ответа.

Тип данных: строка.

Внимание.

Чтобы в ответе получить нужный параметр fields, передайте его в запросе. Если параметр fields не указан, ответ содержит только идентификатор сотрудника.

Запрос профиля сотрудника с указанием необходимых полей:

  • Используется HTTP-метод GET.

  • Ответ содержит только имя, пол, должность и контакты сотрудника: fields=name,gender,position,contacts.

GET /v6/users/123456/?fields=name,gender,position,contacts
Host: https://api.directory.yandex.net
Authorization: OAuth 0c4181a7c2cf4521964a72ff57a34a07
Accept: application/json

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит результаты в формате JSON.

С помощью параметра fields запроса вы можете ограничить перечень полей сотрудника, содержащихся в ответе. Если параметр fields не указан, ответ содержит только идентификатор сотрудника.

{
      "is_robot": <true|false>,
      "external_id": null,
      "position": "<должность>",
      "departments": [
        {
          "id": <id отдела>
        },
        ...        
      ],
      "org_id": <id организации>,
      "gender": "<male|female>",
      "created": "<время и дата создания сотрудника>",
      "name": {
        "first": "<Имя>",
        "last": "<Фамилия>",
        "middle": "<Отчество>"
      },
      "about": "<описание сотрудника>",
      "nickname": "<логин>",
      "groups": [
        {
          "id": <id команды>
        },
        ...
      ],
      "is_admin": <true|false>,
      "birthday": "<ГГГГ-ММ-ДД>",
      "department_id": 3,
      "email": "admin@roga.yaconnect.com",
      "department": {
        "id": 3
      },
      "contacts": [
        {
          "value": "<значение контакта>",
          "type": "<email|phone_extension|phone|site|icq|twitter|facebook|skype>",
          "main": <true|false>,
          "alias": <true|false>,
          "synthetic": <true|false>
        },
        ...
      ],
      "aliases": [
        "<псевдоним1>",
        "<псевдоним2>",
        ...
      ],
      "id": <id сотрудника>,
      "is_dismissed": <true|false>,
      "is_enabled": <true|false>
}
Параметры ответа
Параметр Описание Тип данных
is_robot

Признак служебных сотрудников-ботов:

  • true — бот;

  • false — человек.

Логический.

external_id

Произвольный идентификатор, который вы можете задать при создании сотрудника.

Строка.

position Должность сотрудника.

Строка.

departments Массив объектов с информацией об отделах, к которым относится сотрудник (включая вышестоящие отделы). JSON-массив.
org_id

Идентификатор организации, в которой состоит сотрудник.

Целое число.

gender

Пол сотрудника:

  • male — мужской;

  • female — женский

  • null — пол не указан.

Строка.

created
Дата и время создания сотрудника в формате
YYYY-MM-DDThh:mm:ss.ssssssZ
Строка
name Объект с информацией об имени сотрудника. Объект.
about

Содержимое поля О сотруднике.

Строка.

nickname

Логин сотрудника.

Строка

groups Массив объектов с информацией о командах, в которых состоит сотрудник.

Массив.

is_admin Признак администратора организации:
  • true — администратор;

  • false — рядовой пользователь.

Логический.

birthday

Дата рождения сотрудника в формате

YYYY-MM-DD

Строка.

department_id

Идентификатор отдела, в котором состоит сотрудник.

Целое число.

email

Основной адрес электронной почты сотрудника.

Строка.

department
Объект с информацией об отделе, в котором состоит сотрудник. По умолчанию содержит только поле id. Список полей можно расширить, передав в запросе параметр
fields=department.<имя поля>
. Подробнее о полях отделов читайте в разделе Просмотреть параметры отдела.

JSON-объект.

contacts Массив объектов с информацией о контактах сотрудника.

Массив.

aliases Перечень псевдонимов сотрудника.

Массив.

id Идентификатор сотрудника.

Целое число.

is_dismissed

Статус сотрудника:

  • true — уволенный;

  • false — действующий.

Чтобы восстановить сотрудника, создайте новый профиль с прежним логином.

При увольнении данные об аккаунте сотрудника удаляются.

Логический.

is_enabled

Статус аккаунта сотрудника:

  • true — активен;

  • false — заблокирован.

Логический.

Поля объектов массива departments
id

Идентификатор отдела, к которому относится сотрудник.

Целое число.

Поля объекта name
first

Имя сотрудника

Строка.

last

Фамилия сотрудника

Строка.

middle

Отчество сотрудника

Строка.

Поля объектов массива groups
id

Идентификатор команды, в которой состоит сотрудник.

Целое число.

Поля объекта department
id

Идентификатор отдела.

Целое число.

name

Текстовое название отдела, например, «Отдел разработки».

Строка.

description

Описание отдела.

Строка.

head_id

Идентификатор сотрудника-руководителя отдела.

Целое число.

label

Имя почтового ящика отдела. Имя может состоять только из символов латинского алфавита, цифр, знаков минус и нижнего подчеркивания.

Например, адрес ящика с именем new-department будет new-department@<ваш-домен>.tld.

Строка.

email

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

Строка

parents

Массив объектов с информацией о родительских отделах. Содержит информацию обо всех вышестоящих отделах

JSON-массив.

Поля объектов массива contacts
alias

Если у сотрудника есть псевдоним, для него автоматически создается контакт типа email:

  • true — контакт создан на основе псевдонима;

  • false — контакт создан вручную.

Логический.

value

Адрес ресурса, по которому расположен контакт.

Строка.

type

Тип контакта. Может принимать одно из значений:

  • email;

  • phone_extension;

  • phone;

  • site;

  • icq;

  • twitter;

  • facebook;

  • skype.

Строка.

main

Признак основного контакта:

  • true — основной;

  • false — альтернативный.

У сотрудников может быть только один основной контакт каждого типа.

Логический.

alias

Если у сотрудника есть псевдоним, для него автоматически создается контакт типа email:

  • true — контакт создан на основе псевдонима;

  • false — контакт создан вручную.

Логический.

synthetic

Признак автоматически созданного контакта:

  • true — контакт создан автоматически;

  • false — контакт создан вручную.

Логический.

Параметр Описание Тип данных
is_robot

Признак служебных сотрудников-ботов:

  • true — бот;

  • false — человек.

Логический.

external_id

Произвольный идентификатор, который вы можете задать при создании сотрудника.

Строка.

position Должность сотрудника.

Строка.

departments Массив объектов с информацией об отделах, к которым относится сотрудник (включая вышестоящие отделы). JSON-массив.
org_id

Идентификатор организации, в которой состоит сотрудник.

Целое число.

gender

Пол сотрудника:

  • male — мужской;

  • female — женский

  • null — пол не указан.

Строка.

created
Дата и время создания сотрудника в формате
YYYY-MM-DDThh:mm:ss.ssssssZ
Строка
name Объект с информацией об имени сотрудника. Объект.
about

Содержимое поля О сотруднике.

Строка.

nickname

Логин сотрудника.

Строка

groups Массив объектов с информацией о командах, в которых состоит сотрудник.

Массив.

is_admin Признак администратора организации:
  • true — администратор;

  • false — рядовой пользователь.

Логический.

birthday

Дата рождения сотрудника в формате

YYYY-MM-DD

Строка.

department_id

Идентификатор отдела, в котором состоит сотрудник.

Целое число.

email

Основной адрес электронной почты сотрудника.

Строка.

department
Объект с информацией об отделе, в котором состоит сотрудник. По умолчанию содержит только поле id. Список полей можно расширить, передав в запросе параметр
fields=department.<имя поля>
. Подробнее о полях отделов читайте в разделе Просмотреть параметры отдела.

JSON-объект.

contacts Массив объектов с информацией о контактах сотрудника.

Массив.

aliases Перечень псевдонимов сотрудника.

Массив.

id Идентификатор сотрудника.

Целое число.

is_dismissed

Статус сотрудника:

  • true — уволенный;

  • false — действующий.

Чтобы восстановить сотрудника, создайте новый профиль с прежним логином.

При увольнении данные об аккаунте сотрудника удаляются.

Логический.

is_enabled

Статус аккаунта сотрудника:

  • true — активен;

  • false — заблокирован.

Логический.

Поля объектов массива departments
id

Идентификатор отдела, к которому относится сотрудник.

Целое число.

Поля объекта name
first

Имя сотрудника

Строка.

last

Фамилия сотрудника

Строка.

middle

Отчество сотрудника

Строка.

Поля объектов массива groups
id

Идентификатор команды, в которой состоит сотрудник.

Целое число.

Поля объекта department
id

Идентификатор отдела.

Целое число.

name

Текстовое название отдела, например, «Отдел разработки».

Строка.

description

Описание отдела.

Строка.

head_id

Идентификатор сотрудника-руководителя отдела.

Целое число.

label

Имя почтового ящика отдела. Имя может состоять только из символов латинского алфавита, цифр, знаков минус и нижнего подчеркивания.

Например, адрес ящика с именем new-department будет new-department@<ваш-домен>.tld.

Строка.

email

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

Строка

parents

Массив объектов с информацией о родительских отделах. Содержит информацию обо всех вышестоящих отделах

JSON-массив.

Поля объектов массива contacts
alias

Если у сотрудника есть псевдоним, для него автоматически создается контакт типа email:

  • true — контакт создан на основе псевдонима;

  • false — контакт создан вручную.

Логический.

value

Адрес ресурса, по которому расположен контакт.

Строка.

type

Тип контакта. Может принимать одно из значений:

  • email;

  • phone_extension;

  • phone;

  • site;

  • icq;

  • twitter;

  • facebook;

  • skype.

Строка.

main

Признак основного контакта:

  • true — основной;

  • false — альтернативный.

У сотрудников может быть только один основной контакт каждого типа.

Логический.

alias

Если у сотрудника есть псевдоним, для него автоматически создается контакт типа email:

  • true — контакт создан на основе псевдонима;

  • false — контакт создан вручную.

Логический.

synthetic

Признак автоматически созданного контакта:

  • true — контакт создан автоматически;

  • false — контакт создан вручную.

Логический.