Identity Hub API, gRPC: MfaEnforcementService.List
returns MFA enforcements for the specified organization
gRPC request
rpc List (ListMfaEnforcementsRequest) returns (ListMfaEnforcementsResponse)
ListMfaEnforcementsRequest
{
"organization_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
organization_id |
string Required field. organization id The maximum string length in characters is 50. |
|
page_size |
int64 the maximum number of results per page to return Acceptable values are 0 to 1000, inclusive. |
|
page_token |
string page token The maximum string length in characters is 2000. |
ListMfaEnforcementsResponse
{
"mfa_enforcements": [
{
"id": "string",
"organization_id": "string",
"acr_id": "string",
"ttl": "google.protobuf.Duration",
"status": "MfaEnforcementStatus",
"apply_at": "google.protobuf.Timestamp",
"enroll_window": "google.protobuf.Duration",
"name": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
mfa_enforcements[] |
list of MFA enforcements for the specified organization |
|
next_page_token |
string token to get the next page of results |
MfaEnforcement
MFA enforcement resource
|
Field |
Description |
|
id |
string id of the MFA enforcement |
|
organization_id |
string organization id of the MFA enforcement |
|
acr_id |
string acr id of the MFA enforcement |
|
ttl |
the period during which the entered MFA factor is considered valid and the |
|
status |
enum MfaEnforcementStatus MFA enforcement status
|
|
apply_at |
the MFA enforcement application start time. |
|
enroll_window |
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 |
|
created_at |
creation timestamp |