Checks whether multi-factor authentication (MFA) is enabled for users.

Usage notes

This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is 00fc2p61****. The returned result shows that MFA is in the Enabled state.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetMFAAuthenticationStatus

The operation that you want to perform. Set the value to GetMFAAuthenticationStatus.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String 5E688346-DF1A-5537-9BFC-8A9974D29586

The ID of the request.

MFAAuthenticationStatus String Enabled

The status of MFA. Valid values:

  • Enabled
  • Disabled

Examples

Sample requests

https://[Endpoint]/?Action=GetMFAAuthenticationStatus
&DirectoryId=d-00fc2p61****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetMFAAuthenticationStatusResponse>
    <RequestId>5E688346-DF1A-5537-9BFC-8A9974D29586</RequestId>
    <MFAAuthenticationStatus>Enabled</MFAAuthenticationStatus>
</GetMFAAuthenticationStatusResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "5E688346-DF1A-5537-9BFC-8A9974D29586",
  "MFAAuthenticationStatus" : "Enabled"
}

Error codes

For a list of error codes, visit the API Error Center.