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

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

Примечание

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

Пример:

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

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

userId

Type: string<uint64>

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

Example: ``

Body

application/json

{
  "authType": "example",
  "password": "example",
  "dropOtp": true,
  "passwordChangeRequired": true
}

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

Responses

200 OK

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

Body

application/json

{}

Name

Description

400 Bad Request

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

Body

application/json

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

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

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

Body

application/json

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

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

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

Body

application/json

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

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

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

Body

application/json

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

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

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

Body

application/json

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

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

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

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

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