Updated on 2024-08-02 GMT+08:00

Validating Password Strength

Function

This API is used to check whether an instance password is a weak password.

URI

POST /v3/{project_id}/weak-password-verification

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

User token

You can obtain the token by calling the IAM API used to obtain a user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

password

Yes

String

Character string to be validated

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

is_weak_password

Boolean

Whether the password is a weak password. The value can be: true: indicating that the password is a weak password. Such a password is not recommended. false: indicating that the password is not a weak password. Such a password is recommended.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

Verifying password strength

POST https://{endpoint}/v3/{project_id}/weak-password-verification

{
  "password" : "xxx"
}

Example Response

Status code: 200

OK

{
  "is_weak_password" : true
}

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.