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

Changing the HTTPS Authentication Mode

Function

This API is used to modify 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::updateUserSetting

Write

-

-

-

-

URI

PUT 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
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

https_clone_iam_auth

No

String

Definition:

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

Value range:

1 to 1,000 characters.

Response Parameters

Status code: 200

Table 3 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 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

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

{
  "https_clone_iam_auth" : false
}

Example Responses

Status code: 200

OK

success

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

200

OK

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: User