Obtaining the HTTPS Authentication Mode

This API is used to obtain the HTTPS authentication mode.

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

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

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A.

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.

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

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 Code	Description
200	Obtain the HTTPS authentication mode.
401	Unauthorized
403	Bad Request

Parent topic: User

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.