Skip to main content

UserPasswordParms

Parameters specifying how the password is to be modified. This value may include an actual password or arguments specifying that the service should create a random password.

Properties

NameTypeDescriptionNotes
clear_password_historyboolIf set to true, this flag indicates existing password history is cleared before the new password is created.[optional]
current_passwordstrA value for the current password when changing the AD-User password.[optional]
email_passwordboolA flag indicating whether to email a new password to the user. It defaults to true.[optional]
expiry_timedatetimeThe date at which the password will expire.[optional]
force_updateboolIf set to true, this value indicates the user will be forced to change their password upon next password authentication.[optional]
generate_passwordboolA flag indicating whether a new random password is generated. It defaults to false.[optional]
passwordstrA value for the new password when setting the user password. This value is ignored if generatePassword is set to true.[optional]
password_formatstrDefine the password format of new password, it's BCRYPT when importing BCrypted password, it's GETACCESS when importing GetAccess password,it defaults to CLEARTEXT if not provided.When passwordFormat is BCRYPT or GETACCESS, the following restrictions must be enforced:
  • 1.the user must be an IDaaS local user.
  • 2.currentPassword must be null.
  • 3.generatePassword must be false.
  • 4.emailPassword must be false.
  • 5.returnPassword must be false.

| [optional] [default to 'CLEARTEXT'] return_password | bool | A flag indicating if a password generated by IDaaS should be returned to the caller. This flag is ignored if the password is passed from the client. It defaults to false. | [optional]

Example