Help Center/ CodeArts Repo/ API Reference/ APIs/ User/ Verifying HTTPS Account and Password
Updated on 2025-03-28 GMT+08:00

Verifying HTTPS Account and Password

Function

This API is used to check whether the username and password entered when you upload or download code using HTTPS are valid.

URI

POST /v2/user/{iam_user_uuid}/validate-https-info

Table 1 Path parameters

Parameter

Mandatory

Type

Description

iam_user_uuid

Yes

String

Explanation:

iamId

Range:

32 digits and letters.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token. It can be obtained by calling the corresponding IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory

Range:

1–100,000 characters.

Default value:

None

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

pwd

Yes

String

Explanation:

HTTPS password.

Constraints:

8–32 characters. The password must contain at least three types of the following characters: digits, uppercase letters, lowercase letters, and special characters. It cannot be the same as the username or the username spelled backwards.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

error

Error object

Explanation:

Response error.

Range:

None

result

String

Explanation:

Response result.

Range:

verificationPassed: The password is correct.

status

String

Explanation:

Response status of the API.

Range:

  • success: The API call is successful.
  • failed: The API call failed.
Table 5 Error

Parameter

Type

Description

code

String

Explanation:

Error code returned when the API fails to be called.

Range:

  • CH.080002
  • CH.010112
  • CH.010008

message

String

Explanation:

Error code returned when the API fails to be called.

Range:

  • Incorrect password format.
  • User does not exist.
  • Invalid password.

Example Requests

POST https://{endpoint}/v2/user/{iam_user_uuid}/validate-https-info

{
  "pwd" : "XXX"
}

Example Responses

Status code: 200

OK

{
  "result" : "verificationPassed",
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.