Passwords API

Fetch

Fetch Password Policy
fetchPasswordPolicy
GET /auth/identity/passwordPolicy
PasswordPolicyResponse
required
passwordPolicies PasswordPolicies
PasswordPolicies
required
digits int
The minimum number of numeric digits required in the password string.
forceExpiredPasswordChange int
The number of days the password is valid before a new password is required.
length int
The minimum number of characters allowed in the password.
lowercase int
The minimum number of uppercase characters required in the password string.
maxLength int
The maximum number of characters allowed in the password.
passwordHistory int
The minimum age of a password in days to allow its reuse.
specialChars int
The minimum number of special characters required in the password string.
uppercase int
The minimum number of uppercase characters required in the password string.

Update

Update Password Policy
updatePasswordPolicy
PUT /auth/identity/passwordPolicy
PasswordPolicyUpdateRequest
required
passwordPolicies PasswordPoliciesUpdateRequest
PasswordPoliciesUpdateRequest
optional
digits int?
The minimum number of numeric digits required in the password string.
forceExpiredPasswordChange int?
The number of days the password is valid before a new password is required.
length int?
The minimum number of characters allowed in the password.
lowercase int?
The minimum number of uppercase characters required in the password string.
maxLength int?
The maximum number of characters allowed in the password.
passwordHistory int?
The minimum age of a password in days to allow its reuse.
specialChars int?
The minimum number of special characters required in the password string.
uppercase int?
The minimum number of uppercase characters required in the password string.

Important

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.

See Also