All Products
Search

This Product

    CloudSSO:SetMFAAuthenticationStatus

    Document Center

    CloudSSO:SetMFAAuthenticationStatus

    Last Updated:Aug 28, 2026

    Enables or disables multi-factor authentication (MFA) for users in a directory.

    Operation description

    When a CloudSSO administrator enables username-password logon for users, CloudSSO enables MFA by default to enhance security. Administrators can also call this operation to disable or re-enable MFA as needed.

    This example enables MFA for users.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cloudsso:SetMFAAuthenticationStatus

    update

    *Directory

    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DirectoryId

    string

    Yes

    The ID of the directory.

    d-00fc2p61****
    MFAAuthenticationStatus

    string

    No

    The MFA status. Valid values:

    • Enabled: MFA is enabled.

    • Disabled: MFA is disabled.

    Enabled

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    14E2B1A9-7713-5E6F-8409-8DE12DF51AF4

    Examples

    Success response

    JSON format

    {
  "RequestId": "14E2B1A9-7713-5E6F-8409-8DE12DF51AF4"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.