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

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

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

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

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

Примечание

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

Request

GET

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

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

userId*

Type: string<uint64>

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

Responses

200 OK

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

Body

application/json

{
    "id": "string",
    "is2faEnabled": false
}

Name

Description

id*

Type: string<uint64>

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

is2faEnabled*

Type: boolean

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

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 Описание ошибки.

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

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

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