Updating Custom Password Policies
Function
This API is used to update custom password policies. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.
URI
PUT /v1/identity-stores/{identity_store_id}/password-policy
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
identity_store_id |
Yes |
String |
Globally unique ID of an identity source. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Security-Token |
No |
String |
Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
password_policy |
Yes |
PasswordPolicyDto object |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
minimum_password_length |
No |
Integer |
Minimum password length. |
|
require_lowercase_characters |
No |
Boolean |
Whether lowercase letters are required. |
|
require_numbers |
No |
Boolean |
Whether digits are required. |
|
require_symbols |
No |
Boolean |
Whether special characters are required. |
|
require_uppercase_characters |
No |
Boolean |
Whether uppercase letters are required. |
|
max_password_age |
No |
Integer |
Password validity period. |
|
password_reuse_prevention |
No |
Integer |
Password reuse limit. The default value is 1. |
Response Parameters
Status code: 200
Successful
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
|
request_id |
String |
Unique ID of a request. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
|
request_id |
String |
Unique ID of a request. |
|
encoded_authorization_message |
String |
Encrypted error message. |
Example Request
Updating custom password policies
PUT https://{hostname}/v1/identity-stores/{identity_store_id}/password-policy
{
"password_policy" : {
"minimum_password_length" : 8,
"require_lowercase_characters" : true,
"require_numbers" : true,
"require_symbols" : true,
"require_uppercase_characters" : true,
"max_password_age" : 80,
"password_reuse_prevention" : 1
}
}
Example Response
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Successful. |
|
400 |
Bad request. |
|
403 |
Forbidden. |
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.