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

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

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

Отправить запрос может администратор организации или сотрудник с ролью Менеджер пользователей.

Request

POST

https://cloud-api.yandex.net/v1/api360/directory/org/{org_id}/users/{user_id}/aliases

Path parameters

Name

Description

org_id

Type: integer

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

user_id

Type: string

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

Example: 3456789

Body

application/json

{
  "alias": "employee.alias"
}

Name

Description

alias

Type: string

Алиас почтового ящика пользователя.

Example: employee.alias

Responses

200 OK

Данные сотрудника с добавленным алиасом получены.

Body

application/json

{
  "id": 3456789,
  "nickname": "employee",
  "departmentId": 2345678,
  "email": "employee@example.com",
  "defaultEmail": "employee@example.com",
  "name": {
    "first": "Иван",
    "middle": "Иванович",
    "last": "Иванов"
  },
  "gender": "male",
  "position": "Специалист",
  "avatarId": "1234567890abcdef",
  "about": "Сотрудник отдела разработки.",
  "birthday": "2000-01-01",
  "contacts": [
    {
      "type": "email",
      "value": "employee@example.com",
      "main": true,
      "alias": false,
      "synthetic": false,
      "isForCompletionKeyLink": false,
      "label": "Рабочий"
    }
  ],
  "aliases": [
    "employee.alias"
  ],
  "groups": [
    7654321
  ],
  "externalId": "external-user-123",
  "isAdmin": false,
  "isRobot": false,
  "isDismissed": false,
  "is2faEnabled": true,
  "isEnabled": true,
  "isAgreementAccepted": true,
  "timezone": "Europe/Moscow",
  "language": "ru",
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-02-01T12:45:00.000Z",
  "isEnabledUpdatedAt": "2026-01-20T08:15:00.000Z",
  "completionKeyLinkSendingStatus": {
    "attempts": 1,
    "createdAt": "2026-01-15T10:30:00.000Z",
    "lastAttemptAt": "2026-01-15T10:31:00.000Z",
    "lastSendingStatus": "success",
    "linkExpiresAt": "2026-01-16T10:30:00.000Z"
  }
}

Name	Description
about	Type: string Описание сотрудника. Example: `Сотрудник отдела разработки.`
aliases	Type: string[] Список алиасов сотрудника. Example `[ "employee.alias" ]`
avatarId	Type: string Идентификатор аватара сотрудника. Example: `1234567890abcdef`
birthday	Type: string Дата рождения сотрудника в формате `YYYY-MM-DD`. Может быть пустой строкой. Example: `2000-01-01`
completionKeyLinkSendingStatus	Type: AliasesCompletionKeyLinkSendingStatus Статус отправки смс со ссылкой для завершения регистрации. Отсутствует, если смс со ссылкой не отправлялось. Example `{ "attempts": 1, "createdAt": "2026-01-15T10:30:00.000Z", "lastAttemptAt": "2026-01-15T10:31:00.000Z", "lastSendingStatus": "success", "linkExpiresAt": "2026-01-16T10:30:00.000Z" }`
contacts	Type: AliasesContacts Список контактов сотрудника. Example `[ { "type": "email", "value": "employee@example.com", "main": true, "alias": false, "synthetic": false, "isForCompletionKeyLink": false, "label": "Рабочий" } ]`
createdAt	Type: string<date-time> Дата и время создания сотрудника в формате ISO 8601. Example: `2026-01-15T10:30:00.000Z`
defaultEmail	Type: string Адрес, используемый по умолчанию для отправки писем и отображения в контактах. Example: `employee@example.com`
departmentId	Type: integer Идентификатор подразделения, в котором состоит сотрудник.
email	Type: string Основной адрес электронной почты сотрудника. Example: `employee@example.com`
externalId	Type: string Произвольный внешний идентификатор сотрудника. Example: `external-user-123`
gender	Type: string Пол сотрудника. Example: `male`
groups	Type: integer[] Список идентификаторов групп, в которых состоит сотрудник. Example `[ 7654321 ]`
id	Type: integer Идентификатор сотрудника.
is2faEnabled	Type: boolean Статус обязательной персональной двухфакторной аутентификации: `true` — включена; `false` — выключена.
isAdmin	Type: boolean Признак администратора организации: `true` — администратор; `false` — рядовой пользователь.
isAgreementAccepted	Type: boolean Признак завершения регистрации: `true` — сотрудник завершил регистрацию и принял пользовательское соглашение; `false` — сотрудник не завершил регистрацию.
isDismissed	Type: boolean Статус сотрудника: `true` — уволенный; `false` — действующий.
isEnabled	Type: boolean Статус аккаунта: `true` — активен; `false` — заблокирован.
isEnabledUpdatedAt	Type: string Дата и время последнего изменения статуса аккаунта в формате ISO 8601. Example: `2026-01-20T08:15:00.000Z`
isRobot	Type: boolean Признак служебного бота: `true` — бот; `false` — человек.
language	Type: string Язык сотрудника. Example: `ru`
name	Type: Name ФИО сотрудника. Example `{ "first": "Иван", "middle": "Иванович", "last": "Иванов" }`
nickname	Type: string Логин сотрудника. Example: `employee`
position	Type: string Должность сотрудника. Example: `Специалист`
timezone	Type: string Часовой пояс сотрудника. Example: `Europe/Moscow`
updatedAt	Type: string<date-time> Дата и время изменения данных сотрудника в формате ISO 8601. Example: `2026-02-01T12:45:00.000Z`

Name

ФИО сотрудника.

Name	Description
first	Type: string Имя сотрудника. Example: `Иван`
last	Type: string Фамилия сотрудника. Example: `Иванов`
middle	Type: string Отчество сотрудника. Example: `Иванович`

Example

{
  "first": "Иван",
  "middle": "Иванович",
  "last": "Иванов"
}

ContactsItem

Контакт сотрудника.

Name	Description
alias	Type: boolean Если у сотрудника есть алиас, для него автоматически создается контакт типа `email`: `true` — контакт создан на основе алиаса; `false` — контакт создан вручную.
isForCompletionKeyLink	Type: boolean Признак номера телефона для отправки смс со ссылкой для завершения регистрации: `true` — на этот номер отправляется смс со ссылкой для завершения регистрации; `false` — обычный контакт.
label	Type: string Метка контакта. Example: `Рабочий`
main	Type: boolean Признак основного контакта: `true` — основной; `false` — альтернативный.
synthetic	Type: boolean Признак автоматически созданного контакта: `true` — контакт создан автоматически; `false` — контакт создан вручную.
type	Type: string Тип контакта. Example: `email`
value	Type: string Значение контакта. Example: `employee@example.com`

Example

{
  "type": "email",
  "value": "employee@example.com",
  "main": true,
  "alias": false,
  "synthetic": false,
  "isForCompletionKeyLink": false,
  "label": "Рабочий"
}

AliasesContacts

Список контактов сотрудника.

Type: ContactsItem[]

Example

[
  {
    "type": "email",
    "value": "employee@example.com",
    "main": true,
    "alias": false,
    "synthetic": false,
    "isForCompletionKeyLink": false,
    "label": "Рабочий"
  }
]

AliasesCompletionKeyLinkSendingStatus

Статус отправки смс со ссылкой для завершения регистрации. Отсутствует, если смс со ссылкой не отправлялось.

Name	Description
attempts	Type: integer Количество попыток отправки смс.
createdAt	Type: string<date-time> Дата и время первой попытки отправки. Example: `2026-01-15T10:30:00.000Z`
lastAttemptAt	Type: string<date-time> Дата и время последней попытки отправки. Example: `2026-01-15T10:31:00.000Z`
lastSendingStatus	Type: string Статус последней попытки отправки: `success` — смс отправлено успешно; `failed` — отправить смс не удалось. Enum: `success`, `failed`
linkExpiresAt	Type: string<date-time> Дата и время, до которых действует ссылка. Отсутствует, если успешных попыток отправки не было. Example: `2026-01-16T10:30:00.000Z`

Example

{
  "attempts": 1,
  "createdAt": "2026-01-15T10:30:00.000Z",
  "lastAttemptAt": "2026-01-15T10:31:00.000Z",
  "lastSendingStatus": "success",
  "linkExpiresAt": "2026-01-16T10:30:00.000Z"
}

400 Bad Request

Неверные параметры запроса

Body

application/json

{
  "error": "invalid_argument",
  "description": "Неверные параметры запроса",
  "message": "Неверные параметры запроса",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Неверные параметры запроса

error

Type: string

Код ошибки

Example: invalid_argument

message

Type: string

Сообщение об ошибке.

Example: Неверные параметры запроса

details

Type: object

Дополнительные детали ошибки

Example

{}

403 Forbidden

Доступ запрещен

Body

application/json

{
  "error": "permission_denied",
  "description": "Доступ запрещен",
  "message": "Доступ запрещен",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Доступ запрещен

error

Type: string

Код ошибки

Example: permission_denied

message

Type: string

Сообщение об ошибке.

Example: Доступ запрещен

details

Type: object

Дополнительные детали ошибки

Example

{}

404 Not Found

Ресурс не найден

Body

application/json

{
  "error": "not_found",
  "description": "Ресурс не найден",
  "message": "Ресурс не найден",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Ресурс не найден

error

Type: string

Код ошибки

Example: not_found

message

Type: string

Сообщение об ошибке.

Example: Ресурс не найден

details

Type: object

Дополнительные детали ошибки

Example

{}

409 Conflict

Конфликт - ресурс уже существует

Body

application/json

{
  "error": "already_exists",
  "description": "Конфликт - ресурс уже существует",
  "message": "Конфликт - ресурс уже существует",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Конфликт - ресурс уже существует

error

Type: string

Код ошибки

Example: already_exists

message

Type: string

Сообщение об ошибке.

Example: Конфликт - ресурс уже существует

details

Type: object

Дополнительные детали ошибки

Example

{}

412 Precondition Failed

Функция недоступна или не оплачена

Body

application/json

{
  "error": "failed_precondition",
  "description": "Функция недоступна или не оплачена",
  "message": "Функция недоступна или не оплачена",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Функция недоступна или не оплачена

error

Type: string

Код ошибки

Example: failed_precondition

message

Type: string

Сообщение об ошибке.

Example: Функция недоступна или не оплачена

details

Type: object

Дополнительные детали ошибки

Example

{}

429 Too Many Requests

Превышен лимит запросов

Body

application/json

{
  "error": "resource_exhausted",
  "description": "Превышен лимит запросов",
  "message": "Превышен лимит запросов",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Превышен лимит запросов

error

Type: string

Код ошибки

Example: resource_exhausted

message

Type: string

Сообщение об ошибке.

Example: Превышен лимит запросов

details

Type: object

Дополнительные детали ошибки

Example

{}

500 Internal Server Error

Внутренняя ошибка сервера

Body

application/json

{
  "error": "internal",
  "description": "Внутренняя ошибка сервера",
  "message": "Внутренняя ошибка сервера",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Внутренняя ошибка сервера

error

Type: string

Код ошибки

Example: internal

message

Type: string

Сообщение об ошибке.

Example: Внутренняя ошибка сервера

details

Type: object

Дополнительные детали ошибки

Example

{}

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

Обзор

Удалить алиас