Passwords API
| Action | Endpoint |
|---|---|
| Fetch Password Policy | GET/auth/identity/passwordPolicy |
| Update Password Policy | PUT/auth/identity/passwordPolicy |
Fetch
Fetch Password Policy
Fetch Password Policy
fetchPasswordPolicyGET
/auth/identity/passwordPolicyResponse:
PasswordPolicyResponseSecurity Group:
identityPermissions:
read,customPasswordPolicyResponse
Required properties
| Property | Type | Description |
|---|---|---|
passwordPolicies | PasswordPolicies |
PasswordPolicies
Required properties
| Property | Type | Description |
|---|---|---|
digits | integer | The minimum number of numeric digits required in the password string. |
forceExpiredPasswordChange | integer | The number of days the password is valid before a new password is required. |
length | integer | The minimum number of characters allowed in the password. |
lowercase | integer | The minimum number of uppercase characters required in the password string. |
maxLength | integer | The maximum number of characters allowed in the password. |
passwordHistory | integer | The count of previous passwords that are not allowed to be reused, starting with the most recent. |
specialChars | integer | The minimum number of special characters required in the password string. |
uppercase | integer | The minimum number of uppercase characters required in the password string. |
Update
Update Password Policy
Update Password Policy
updatePasswordPolicyPUT
/auth/identity/passwordPolicyPasswordPolicyUpdateRequest
Required properties
| Property | Type | Description |
|---|---|---|
passwordPolicies | PasswordPoliciesUpdateRequest |
PasswordPoliciesUpdateRequest
Properties
| Property | Type | Description |
|---|---|---|
digits | integer? | The minimum number of numeric digits required in the password string. |
forceExpiredPasswordChange | integer? | The number of days the password is valid before a new password is required. |
length | integer? | The minimum number of characters allowed in the password. |
lowercase | integer? | The minimum number of uppercase characters required in the password string. |
maxLength | integer? | The maximum number of characters allowed in the password. |
passwordHistory | integer? | The minimum age of a password in days to allow its reuse. |
specialChars | integer? | The minimum number of special characters required in the password string. |
uppercase | integer? | The minimum number of uppercase characters required in the password string. |
The Update Password Policy endpoint is a PUT endpoint, which means all the password policy settings will be replaced. If any properties are not included in the update request, the default values will be used.