Изменить способ входа

Переключает способ входа для пользователя.

Примечание

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

Пример:

curl --request PATCH 'https://api360.yandex.net/directory/v1/org/{orgId}/users/{userId}/auth_type' \
    --header 'Authorization: OAuth token'

Request

PATCH

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

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

userId*

Type: string<uint64>

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

Body

application/json

{
    "authType": "string",
    "password": "string",
    "dropOtp": false,
    "passwordChangeRequired": false
}

Name	Description
authType*	Type: string Тип аутентификации, который надо установить пользователю. Возможные значения: `portal` — по логину и паролю в Яндекс 360 для бизнеса (аккаунты на домене организации); `idp` — с помощью SSO через поставщика удостоверений.
dropOtp	Type: boolean Параметр, который определяет, необходимо ли сбросить одноразовые пароли (для входа по одноразовому паролю или по двухфакторной аутентификации — комбинации постоянного и одноразового паролей). Указывается при смене типа входа с `portal` на `idp`. Возможные значения: `true` — сбрасывать одноразовые пароли; `false` — оставить текущие одноразовые пароли. Значение по умолчанию — `false`.
password	Type: string Пароль от аккаунта в Яндекс 360 для бизнеса. При смене типа входа с `idp` на `portal` обязателен.
passwordChangeRequired	Type: boolean Параметр, который определяет, необходимо ли изменить пароль при первом входе. Устанавливается при смене типа входа с `idp` на `portal`. Возможные значения: `true` — пользователь должен установить новый пароль при первом входе; `false` — менять пароль при первом вхоже не надо. Значение по умолчанию — `false`.

Responses

200 OK

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

Body

application/json

{}

400 Bad Request

Некорректный запрос.

Body

application/json

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

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

protobufAny

Name	Description
@type	Type: string
[additional]	Type: any

401 Unauthorized

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

Body

application/json

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

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

403 Forbidden

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

Body

application/json

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

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

404 Not Found

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

Body

application/json

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

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

500 Internal Server Error

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

Body

application/json

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

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

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

Посмотреть способ входа

Загрузить портрет