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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID of a tenant in a region |
Request 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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
password |
Yes |
String |
Character string to be validated |
Response Parameters
Status code: 200
|
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: default
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code |
|
error_msg |
String |
Error message |
Example Request
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 |
|
default |
Client or server error. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
