Добавить

HTTP-запрос

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

Path-параметры

orgId *

integer

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

* Обязательный параметр

Тело запроса

{
  "about": string,
  "birthday": string,
  "contacts": [
    {
      "label": string,
      "type": string,
      "value": string
    }
  ],
  "departmentId": integer,
  "displayName": string,
  "externalId": string,
  "gender": string,
  "isAdmin": boolean,
  "language": string,
  "name": {
    "first": string,
    "last": string,
    "middle": string
  },
  "nickname": string,
  "password": string,
  "passwordChangeRequired": boolean,
  "position": string,
  "timezone": string
}
Скопировано

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

Свернуть всё

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

Поля

about	string Описание сотрудника.
birthday	string Дата рождения сотрудника. Формат `YYYY-MM-DD`.
contacts[]	array Список контактов сотрудника.
contacts[].label	string Произвольная метка контакта.
contacts[].type *	string Тип контакта. Возможные значения: `email`; `phone_extension`; `phone`; `site`; `icq`; `twitter`; `skype`.
contacts[].value *	string Значение контакта.
departmentId *	integer Идентификатор подразделения, в котором состоит сотрудник.
displayName	string Публичное имя сотрудника – имя, которое сотрудник использует в своем профиле для представления себя, оно может совпадать с реальным именем, быть псевдонимом или никнеймом.
externalId	string Произвольный внешний идентификатор сотрудника.
gender	string Пол сотрудника.
isAdmin	boolean Признак администратора организации: `true` — администратор; `false` — рядовой пользователь.
language	string Язык сотрудника.
name *	object ФИО сотрудника.
name.first *	string Имя сотрудника.
name.last *	string Фамилия сотрудника.
name.middle	string Отчество сотрудника.
nickname *	string Логин сотрудника.
password *	string Пароль сотрудника.
passwordChangeRequired	boolean Обязательность изменения пароля при первом входе: `true` — обязательно; `false` — необязательно.
position	string Должность сотрудника.
timezone	string Часовой пояс сотрудника.

* Обязательный параметр

Ответы

Код 200

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

{
  "about": string,
  "aliases": [
    string
  ],
  "avatarId": string,
  "birthday": string,
  "contacts": [
    {
      "alias": boolean,
      "label": string,
      "main": boolean,
      "synthetic": boolean,
      "type": string,
      "value": string
    }
  ],
  "createdAt": string,
  "departmentId": integer,
  "displayName": string,
  "email": string,
  "externalId": string,
  "gender": string,
  "groups": [
    integer
  ],
  "id": string,
  "isAdmin": boolean,
  "isDismissed": boolean,
  "isEnabled": boolean,
  "isRobot": boolean,
  "language": string,
  "name": {
    "first": string,
    "last": string,
    "middle": string
  },
  "nickname": string,
  "position": string,
  "timezone": string,
  "updatedAt": string
}
Скопировано

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

Свернуть всё

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

Поля

about	string Описание сотрудника.
aliases[]	array Список алиасов сотрудника.
avatarId	string Идентификатор портрета сотрудника.
birthday	string Дата рождения сотрудника. В формате `YYYY-MM-DD` или пустая строка.
contacts[]	array Список контактов сотрудника.
contacts[].alias	boolean Если у сотрудника есть алиас, для него автоматически создается контакт типа `email`: `true` — контакт создан на основе алиаса; `false` — контакт создан вручную.
contacts[].label	string Произвольная метка контакта.
contacts[].main	boolean Признак основного контакта: `true` — основной; `false` — альтернативный.
contacts[].synthetic	boolean Признак автоматически созданного контакта: `true` — контакт создан автоматически; `false` — контакт создан вручную.
contacts[].type	string Тип контакта.
contacts[].value	string Значение контакта.
createdAt	string Дата и время создания сотрудника.
departmentId *	integer Идентификатор подразделения, в котором состоит сотрудник.
displayName	string Публичное имя сотрудника – имя, которое сотрудник использует в своем профиле для представления себя, оно может совпадать с реальным именем, быть псевдонимом или никнеймом.
email	string Основной адрес электронной почты сотрудника.
externalId	string Произвольный внешний идентификатор сотрудника.
gender	string Пол сотрудника.
groups[]	array Идентификаторы групп, в которых состоит сотрудник.
id	string Идентификатор сотрудника.
isAdmin	boolean Признак администратора организации: `true` — администратор; `false` — рядовой пользователь.
isDismissed	boolean Статус сотрудника: `true` — уволенный; `false` — действующий.
isEnabled	boolean Статус аккаунта сотрудника: `true` — активен; `false` — заблокирован.
isRobot	boolean Признак служебных сотрудников-ботов: `true` — бот; `false` — человек.
language	string Язык сотрудника.
name *	object ФИО сотрудника.
name.first	string Имя сотрудника.
name.last	string Фамилия сотрудника.
name.middle	string Отчество сотрудника.
nickname *	string Логин сотрудника.
position	string Должность сотрудника.
timezone	string Часовой пояс сотрудника.
updatedAt	string Дата и время изменения сотрудника.

about	string Описание сотрудника.
aliases[]	array Список алиасов сотрудника.
avatarId	string Идентификатор портрета сотрудника.
birthday	string Дата рождения сотрудника. В формате `YYYY-MM-DD` или пустая строка.
contacts[]	array Список контактов сотрудника.
contacts[].alias	boolean Если у сотрудника есть алиас, для него автоматически создается контакт типа `email`: `true` — контакт создан на основе алиаса; `false` — контакт создан вручную.
contacts[].label	string Произвольная метка контакта.
contacts[].main	boolean Признак основного контакта: `true` — основной; `false` — альтернативный.
contacts[].synthetic	boolean Признак автоматически созданного контакта: `true` — контакт создан автоматически; `false` — контакт создан вручную.
contacts[].type	string Тип контакта.
contacts[].value	string Значение контакта.
createdAt	string Дата и время создания сотрудника.
departmentId *	integer Идентификатор подразделения, в котором состоит сотрудник.
displayName	string Публичное имя сотрудника – имя, которое сотрудник использует в своем профиле для представления себя, оно может совпадать с реальным именем, быть псевдонимом или никнеймом.
email	string Основной адрес электронной почты сотрудника.
externalId	string Произвольный внешний идентификатор сотрудника.
gender	string Пол сотрудника.
groups[]	array Идентификаторы групп, в которых состоит сотрудник.
id	string Идентификатор сотрудника.
isAdmin	boolean Признак администратора организации: `true` — администратор; `false` — рядовой пользователь.
isDismissed	boolean Статус сотрудника: `true` — уволенный; `false` — действующий.
isEnabled	boolean Статус аккаунта сотрудника: `true` — активен; `false` — заблокирован.
isRobot	boolean Признак служебных сотрудников-ботов: `true` — бот; `false` — человек.
language	string Язык сотрудника.
name *	object ФИО сотрудника.
name.first	string Имя сотрудника.
name.last	string Фамилия сотрудника.
name.middle	string Отчество сотрудника.
nickname *	string Логин сотрудника.
position	string Должность сотрудника.
timezone	string Часовой пояс сотрудника.
updatedAt	string Дата и время изменения сотрудника.

* Обязательный параметр

Код 401

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

{
  "code": integer,
  "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

* Обязательный параметр

Код 404

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

{
  "code": integer,
  "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

* Обязательный параметр

Пример

Request:

curl -X POST "https://api360.yandex.net/directory/v1/org/{orgId}/users" \
-d '{
  "birthday": "1999-11-22"
}'
Скопировано