Изменить информацию

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

Примечание

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

Request

PATCH

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

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

userId*

Type: string<uint64>

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

Body

application/json

{
    "departmentId": 0,
    "name": {
        "first": "string",
        "last": "string",
        "middle": "string"
    },
    "gender": "string",
    "position": "string",
    "about": "string",
    "birthday": "1999-11-22",
    "contacts": [
        {
            "type": "string",
            "value": "string",
            "label": "string"
        }
    ],
    "externalId": "string",
    "isAdmin": false,
    "isEnabled": false,
    "timezone": "string",
    "language": "string",
    "password": "string",
    "passwordChangeRequired": false,
    "displayName": "string"
}

Name	Description
about	Type: string Описание сотрудника.
birthday	Type: string<date> Дата рождения сотрудника. Формат `YYYY-MM-DD`. Example: `1999-11-22` Pattern: `^\d{4}-\d{2}-\d{2}$`
contacts	Type: v1UserContactParams[] Список контактов сотрудника. Контакты сотрудника.
departmentId	Type: integer<int64> Идентификатор подразделения сотрудника.
displayName	Type: string Публичное имя сотрудника – имя, которое сотрудник использует в своем профиле для представления себя, оно может совпадать с реальным именем, быть псевдонимом или никнеймом.
externalId	Type: string Произвольный внешний идентификатор сотрудника.
gender	Type: string Пол сотрудника.
isAdmin	Type: boolean Признак администратора организации: `true` — администратор; `false` — рядовой пользователь.
isEnabled	Type: boolean Статус аккаунта сотрудника: `true` — активен; `false` — заблокирован.
language	Type: string Язык сотрудника.
name	Type: v1UserNameParams ФИО сотрудника.
password	Type: string Пароль сотрудника.
passwordChangeRequired	Type: boolean Обязательность изменения пароля при первом входе: `true` — обязательно; `false` — необязательно.
position	Type: string Должность сотрудника.
timezone	Type: string Часовой пояс сотрудника.

v1UserContactParams

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

Name	Description
type*	Type: string Тип контакта. Возможные значения: `email`; `phone_extension`; `phone`; `site`; `icq`; `twitter`; `skype`.
value*	Type: string Значение контакта.
label	Type: string Произвольная метка контакта.

v1UserNameParams

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

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

Responses

200 OK

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

Body

application/json

{
    "id": "string",
    "nickname": "string",
    "departmentId": 0,
    "email": "string",
    "name": {
        "first": "string",
        "last": "string",
        "middle": "string"
    },
    "gender": "string",
    "position": "string",
    "avatarId": "string",
    "about": "string",
    "birthday": "string",
    "contacts": [
        {
            "type": "string",
            "value": "string",
            "main": false,
            "alias": false,
            "synthetic": false,
            "label": "string"
        }
    ],
    "aliases": [
        "string"
    ],
    "groups": [
        0
    ],
    "externalId": "string",
    "isAdmin": false,
    "isRobot": false,
    "isDismissed": false,
    "isEnabled": false,
    "timezone": "string",
    "language": "string",
    "createdAt": "2022-12-29T18:02:01Z",
    "updatedAt": "2022-12-29T18:02:01Z",
    "displayName": "string"
}

Name	Description
about	Type: string Описание сотрудника.
aliases	Type: string[] Список алиасов сотрудника.
avatarId	Type: string Идентификатор портрета сотрудника.
birthday	Type: string Дата рождения сотрудника. В формате `YYYY-MM-DD` или пустая строка.
contacts	Type: v1UserContact[] Список контактов сотрудника. Контакты сотрудника.
createdAt	Type: string<date-time> Дата и время создания сотрудника.
departmentId	Type: integer<int64> Идентификатор подразделения, в котором состоит сотрудник.
displayName	Type: string Публичное имя сотрудника – имя, которое сотрудник использует в своем профиле для представления себя, оно может совпадать с реальным именем, быть псевдонимом или никнеймом.
email	Type: string Основной адрес электронной почты сотрудника.
externalId	Type: string Произвольный внешний идентификатор сотрудника.
gender	Type: string Пол сотрудника.
groups	Type: integer<int64>[] Идентификаторы групп, в которых состоит сотрудник.
id	Type: string<uint64> Идентификатор сотрудника.
isAdmin	Type: boolean Признак администратора организации: `true` — администратор; `false` — рядовой пользователь.
isDismissed	Type: boolean Статус сотрудника: `true` — уволенный; `false` — действующий.
isEnabled	Type: boolean Статус аккаунта сотрудника: `true` — активен; `false` — заблокирован.
isRobot	Type: boolean Признак служебных сотрудников-ботов: `true` — бот; `false` — человек.
language	Type: string Язык сотрудника.
name	Type: v1UserName ФИО сотрудника.
nickname	Type: string Логин сотрудника.
position	Type: string Должность сотрудника.
timezone	Type: string Часовой пояс сотрудника.
updatedAt	Type: string<date-time> Дата и время изменения сотрудника.

v1UserContact

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

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

v1UserName

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

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

401 Unauthorized

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

404 Not Found

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

Изменить информацию

RequestRequest

Path parametersPath parameters

BodyBody

v1UserContactParamsv1UserContactParams

v1UserNameParamsv1UserNameParams

ResponsesResponses

200 OK200 OK

BodyBody

v1UserContactv1UserContact

v1UserNamev1UserName

401 Unauthorized401 Unauthorized

BodyBody

403 Forbidden403 Forbidden

BodyBody

404 Not Found404 Not Found

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

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

Request

Path parameters

Body

v1UserContactParams

v1UserNameParams

Responses

200 OK

Body

v1UserContact

v1UserName

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

500 Internal Server Error

Body