Identity Hub API, REST: MfaEnforcement.List
returns MFA enforcements for the specified organization
HTTP request
GET https://organization-manager.api.yandexcloud.kz/organization-manager/v1/mfaEnforcements
Query parameters
|
Field |
Description |
|
organizationId |
string Required field. organization id The maximum string length in characters is 50. |
|
pageSize |
string (int64) the maximum number of results per page to return Acceptable values are 0 to 1000, inclusive. |
|
pageToken |
string page token The maximum string length in characters is 2000. |
Response
HTTP Code: 200 - OK
{
"mfaEnforcements": [
{
"id": "string",
"organizationId": "string",
"acrId": "string",
"ttl": "string",
"status": "string",
"applyAt": "string",
"enrollWindow": "string",
"name": "string",
"description": "string",
"createdAt": "string"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
mfaEnforcements[] |
list of MFA enforcements for the specified organization |
|
nextPageToken |
string token to get the next page of results |
MfaEnforcement
MFA enforcement resource
|
Field |
Description |
|
id |
string id of the MFA enforcement |
|
organizationId |
string organization id of the MFA enforcement |
|
acrId |
string acr id of the MFA enforcement |
|
ttl |
string (duration) the period during which the entered MFA factor is considered valid and the |
|
status |
enum (MfaEnforcementStatus) MFA enforcement status
|
|
applyAt |
string (date-time) the MFA enforcement application start time. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
enrollWindow |
string (duration) the time window during which the user is allowed to create an MFA profile. |
|
name |
string name of the MFA enforcement |
|
description |
string description of the MFA enforcement |
|
createdAt |
string (date-time) creation timestamp String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |