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
ClearPasswordHistorybool?If set to true, this flag indicates existing password history is cleared before the new password is created.[optional]
CurrentPasswordstringA value for the current password when changing the AD-User password.[optional]
EmailPasswordbool?A flag indicating whether to email a new password to the user. It defaults to true.[optional]
ExpiryTimeDateTime?The date at which the password will expire.[optional]
ForceUpdatebool?If set to true, this value indicates the user will be forced to change their password upon next password authentication.[optional]
GeneratePasswordbool?A flag indicating whether a new random password is generated. It defaults to false.[optional]
PasswordstringA value for the new password when setting the user password. This value is ignored if generatePassword is set to true.[optional]
PasswordFormatstringDefine 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 PasswordFormatEnum.CLEARTEXT] ReturnPassword | 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]