Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ User/ Obtaining the HTTPS Authentication Mode
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the HTTPS Authentication Mode

Function

This API is used to obtain the HTTPS authentication mode.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo::getUserSetting

Read

-

-

-

-

URI

GET https://{hostURL}/v4/user/https-password-setting

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

-

String

Definition:

Whether to use the HTTPS authentication mode: true or false.

Value range:

1 to 1,000 characters.

Status code: 401

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/user/https-password-setting

Example Responses

Status code: 200

Obtain the HTTPS authentication mode.

true

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

200

Obtain the HTTPS authentication mode.

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: User