Validating Password Strength¶

Function¶

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

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

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
password	Yes	String	Character string to be validated

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

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

{
  "password" : "xxx"
}

Status code: 200

{
  "is_weak_password" : true
}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status code: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

For details, see Error Codes.

last updated: 2024-12-11 13:43 UTC - commit: 0e04c4a111cf440cbe530f17da84f5c1ac074d8f