Updated on 2025-09-08 GMT+08:00

Configuring Two-Factor Login

Function

This API is used to configure two-factor login.

Calling Method

For details, see Calling APIs.

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" ]
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

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.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;

import java.util.List;
import java.util.ArrayList;

public class SetTwoFactorLoginConfigSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        SetTwoFactorLoginConfigRequest request = new SetTwoFactorLoginConfigRequest();
        SetTwoFactorLoginConfigRequestBody body = new SetTwoFactorLoginConfigRequestBody();
        List<String> listbodyHostIdList = new ArrayList<>();
        listbodyHostIdList.add("09724867-7b91-482d-9702-daf9113f1b62");
        body.withHostIdList(listbodyHostIdList);
        body.withTopicUrn("urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling");
        body.withTopicDisplayName("liuzhaoli");
        body.withAuthType("sms");
        body.withEnabled(true);
        request.withBody(body);
        try {
            SetTwoFactorLoginConfigResponse response = client.setTwoFactorLoginConfig(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = SetTwoFactorLoginConfigRequest()
        listHostIdListbody = [
            "09724867-7b91-482d-9702-daf9113f1b62"
        ]
        request.body = SetTwoFactorLoginConfigRequestBody(
            host_id_list=listHostIdListbody,
            topic_urn="urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling",
            topic_display_name="liuzhaoli",
            auth_type="sms",
            enabled=True
        )
        response = client.set_two_factor_login_config(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SetTwoFactorLoginConfigRequest{}
	var listHostIdListbody = []string{
        "09724867-7b91-482d-9702-daf9113f1b62",
    }
	request.Body = &model.SetTwoFactorLoginConfigRequestBody{
		HostIdList: listHostIdListbody,
		TopicUrn: "urn:smn:cn-north-4:06ff15244b2748b49e69c2140b319e9e:liuzhaoling",
		TopicDisplayName: "liuzhaoli",
		AuthType: "sms",
		Enabled: true,
	}
	response, err := client.SetTwoFactorLoginConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.