All Products
Search

This Product

    CloudSSO:GetMFAAuthenticationSettings

    Document Center

    CloudSSO:GetMFAAuthenticationSettings

    Last Updated:Mar 29, 2024

    Queries the multi-factor authentication (MFA) setting of all users.

    Operation description

    Note This operation is no longer maintained and updated. You can call the GetMFAAuthenticationSettingInfo operation to query more detailed information.

    This topic provides an example on how to query the MFA setting of the users that belong to the directory named d-00fc2p61****. The returned result shows that MFA is enabled for all the users.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    cloudsso:GetMFAAuthenticationSettingsRead
    • Directory
      acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DirectoryIdstringYes

    The ID of the directory.

    		d-00fc2p61****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		A2BC00C5-76A2-5FFC-A340-927940A98377
    MFAAuthenticationAdvanceSettingsstring

    Indicates whether MFA is enabled for all users. Valid values:

    • Enabled: MFA is enabled for all users.
    • Byuser: User-specific settings are applied.
    • Disabled: MFA is disabled for all users.
    		Enabled

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "A2BC00C5-76A2-5FFC-A340-927940A98377",
  "MFAAuthenticationAdvanceSettings": "Enabled"
}

    Error codes

    For a list of error codes, visit the Service error codes.