Изменить статус персональной 2FA

Обновляет статус персональной двухфакторной аутентификации сотрудника. Доступен только в тарифах для крупных организаций «Корпоративный + Безопасность» и «Корпоративный Максимум».

Метод актуален, если:

в организации установлена двухфакторная аутентификация через сервис для управления 2FA (v2) с возможностью персональной настройки или в интерфейсе Кабинета организации;
режим двухфакторной аутентификации scope: per_user — только отдельным сотрудникам.

Узнать режим, который установлен для 2FA в вашей организации, можно с помощью метода, описанного в разделе Посмотреть статус 2FA с возможностью персональной настройки.

Примечание

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

Request

PATCH

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

Path parameters

Name

Description

orgId

Type: integer

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

userId

Type: string<uint64>

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

Example: ``

Query parameters

Name

Description

is2faEnabled

Type: boolean

Параметр, который определяет, должна ли быть у сотрудника включена персональная двухфакторная аутентификация. Возможные значения: true — включить персональную 2FA сотруднику; false — выключить персональную 2FA сотруднику.

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`

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

Посмотреть статус персональной 2FA

Обзор