Добавить алиас

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

Добавляет сотруднику алиас почтового ящика.

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

HTTP-запрос

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

Path-параметры

orgId *

integer

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

userId *

string

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

orgId *

integer

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

userId *

string

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

Тело запроса

{
  "alias": string
}
Скопировано

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

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

Поля

alias *

string

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

alias *

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

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