Update the password policy for a specified tenant.

put https://{tenanturl}/v2.0/PasswordPolicies

Entitlement required: managePwdPolicy (Manage password policy).

Body Params

The password policy object that contains the attributes for the password policy that is to be updated.

schemas

array of strings

required

An array of strings that contain the URIs that indicate the namespaces of the SCIM schemas that define the attributes in the current JSON structure. The schema "urn:ietf:params:scim:schemas:ibm:core:2.0:policy:Password" is returned.

schemas*

passwordMinAlphaChars

int32

required

Specifies the minimum number of alphabetic characters that the password string must have. If the server is unable to check the number of alphabetic characters, then the server continues processing depending on the value of the pwdCheckSyntax attribute.

passwordMinOtherChars

int32

required

Specifies the minimum number of numeric and special characters that the password string must have. If the server is unable to check the number of other characters, then the server continues processing depending on the value of the pwdCheckSyntax attribute.

pwdMinAge

int32

required

Specifies the number of days before a password can be modified again.

pwdExpireWarning

int32

required

Specifies the maximum number of days before a password expires that an expiration warning message is returned to an authenticating user.

pwdInHistory

int32

required

Specifies the number of passwords that are stored in the pwdHistory attribute.

pwdLockout

boolean

required

Indicates whether a password can be used to authenticate after a specified number of consecutive failed bind attempts. If the attribute is not provided, the behavior defaults to false.

pwdLockoutDuration

int32

required

Specifies the number of minutes that the password cannot be used to authenticate due to the specified 'pwdMaxFailure' failed bind attempts.

pwdMaxAge

int32

required

Specifies the number of days after which a password will expire (0 means password does not expire)

pwdMaxFailure

int32

required

Specifies the maximum number of consecutive failed bind attempts after which the password cannot be used for authentication. If a value of 0 is set for the pwdMaxFailure attribute, the value of pwdLockout is ignored.

pwdMinLength

int32

required

Specifies the minimum length for the password string. The server checks the minimum length depending upon the value of the pwdCheckSyntax attribute.

Responses

Response body

object

schemas

array of strings

required

schemas*

passwordMinAlphaChars

int32

passwordMinOtherChars

int32

pwdMinAge

int32

Specifies the number of days before a password can be modified again.

pwdExpireWarning

int32

Specifies the maximum number of days before a password expires that an expiration warning message is returned to an authenticating user.

pwdInHistory

int32

Specifies the number of passwords that are stored in the pwdHistory attribute.

pwdLockout

boolean

Indicates whether a password can be used to authenticate after a specified number of consecutive failed bind attempts. If the attribute is not provided, the behavior defaults to false.

pwdLockoutDuration

int32

Specifies the number of minutes that the password cannot be used to authenticate due to the specified 'pwdMaxFailure' failed bind attempts.

pwdMaxAge

int32

Specifies the number of days after which a password expires. (A value of 0 means that the password does not expire.)

pwdMaxFailure

int32

Specifies the maximum number of consecutive failed bind attempts after which the password will not be used for authentication. If a value of 0 is set for the pwdMaxFailure attribute, the value of pwdLockout is ignored.

pwdMinLength

int32

Specifies the minimum length for the password string. The server checks the minimum length depending upon the value of the pwdCheckSyntax attribute.

pwdGraceLoginLimit

int32

Specifies the number of times an expired password can be used to authenticate user. This value is read-only and is ignored on the PUT operation.

pwdMustChange

boolean

Specifies whether the users must change their passwords when they first bind to the directory after the administrator has reset their passwords. This value is read-only and is ignored on the PUT operation.

pwdAllowUserChange

boolean

Specifies whether the users are allowed to change their own passwords. This value is read-only and is ignored on the PUT operation.

pwdFailureCountInterval

int32

Specifies the number of seconds after which the password failures are removed from the failure counter even if no successful authentication has occurred. This value is read-only and is ignored on the PUT operation.

passwordMaxRepeatedChars

int32

Specifies the maximum number of times a character can be used in a password. If the server is unable to check the actual password characters, then the server continues processing depending on the value of the pwdCheckSyntax attribute. This value is read-only and is ignored on the PUT operation.

pwdSafeModify

boolean

Specifies whether the existing password must be sent when changing a password. This value is read-only and is ignored on the PUT operation.

passwordMaxConsecutiveRepeatedChars

int32

Used to restrict the maximum successive repetitions of a character in the password. This value is read-only and is ignored on the PUT operation.

passwordMinDiffChars

int32

Specifies the minimum number of characters in the new password that must be different from the characters in the old password, and any passwords stored in the pwdHistory. If the password was one-way encrypted, the server cannot check actual password characters. The server continues processing depending on the value of the pwdCheckSyntax attribute. This value is read-only and is ignored on the PUT operation.

pwdCheckSyntax

int32

Indicates whether the password is checked for syntax. The values of the pwdCheckSynatx attribute are: '0' means that syntax checking is not enforced. '1' means that the server checks the syntax. If the server cannot check the syntax (for example, because of a hashed password), the password is accepted. '2' means that the server checks the syntax. If the server cannot check the syntax (for example, because of a hashed password), it returns an error and the password is rejected. This value is read-only and is ignored on the PUT operation.

ibm_pwdPolicy

boolean

Specifies whether to turn the password policy on or off. This value is read-only and is ignored on the PUT operation.

Language

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://tenant_url/v2.0/PasswordPolicies \
3
     --header 'accept: application/scim+json' \
4
     --header 'content-type: application/scim+json' \
5
     --data '{"pwdLockout":true}'

Choose an example:

application/scim+json

200The operation was successful.

400The request was incorrect.

500An internal server error occurred.