Посмотреть статус 2FA
Возвращает информацию о том, распространяется ли на сотрудника необходимость двухфакторной аутентификации в случае, когда она установлена через сервис для включения/отключения 2FA (v1).
В ответе метод вернет параметр has2fa со значением:
true— если пользователь настроил 2FA самостоятельно.false— если администратор подключил принудительную 2FA всем пользователям (scope=per_domain) или выбранному пользователю (scope=per_user). Узнать режим, который установлен для 2FA в вашей организации, можно с помощью метода, описанного в разделе Посмотреть статус 2FA с возможностью персональной настройки.
Примечание
Требуется разрешение на чтение данных сотрудников.
Request
GET
https://api360.yandex.net/directory/v1/org/{orgId}/users/{userId}/2fa
Path parameters
|
Name |
Description |
|
orgId |
Type: integer Идентификатор организации. |
|
userId |
Type: string<uint64> Идентификатор сотрудника. Example: `` |
Responses
200 OK
200 OK — запрос выполнен успешно.
Body
application/json
{
"userId": "example",
"has2fa": true,
"hasSecurityPhone": true
}
|
Name |
Description |
|
has2fa |
Type: boolean Признак того, что у сотрудника настроена двухфакторная аутентификация. |
|
hasSecurityPhone |
Type: boolean Признак настроенного телефона для защиты аккаунта. |
|
userId |
Type: string<uint64> Идентификатор сотрудника. Example: |
400 Bad Request
400 Bad Request — некорректный запрос.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
protobufAny
|
Name |
Description |
|
@type |
Type: string Example: |
|
[additional] |
Type: unknown Example: |
Example
{
"@type": "example"
}
401 Unauthorized
401 Unauthorized — пользователь не авторизован.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
403 Forbidden
403 Forbidden — у пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
404 Not Found
404 Not Found — запрашиваемый ресурс не найден.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
500 Internal Server Error
500 Internal Server Error — внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |