Configuring Two-Factor Login

Function

This API is used to configure two-factor login.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

PUT /v5/{project_id}/setting/two-factor-login/config

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
enabled	Yes	Boolean	Whether to enable two-factor authentication
auth_type	Yes	String	Authentication type. The options are as follows: sms: SMS/Email verification code: verification code
topic_display_name	Yes	String	Display name
topic_urn	Yes	String	Indicates the unique resource ID for the topic.
host_id_list	Yes	Array of strings	Server list

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Enable two-factor authentication, set the authentication type to SMS/Email verification, set the topic alias to liuzhaoli, set the unique resource ID of the topic to urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling, and set the server list to 09724867-7b91-482d-9702-daf9113f1b62.

{
  "enabled" : true,
  "auth_type" : "sms",
  "topic_display_name" : "liuzhaoli",
  "topic_urn" : "urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling",
  "host_id_list" : [ "09724867-7b91-482d-9702-daf9113f1b62" ]
}