Skip to main content

Password operations

Admin Verify

Validates if a password is valid for a specified account, without incrementing the password lockout count.

Signature: adminverify(cinfo)

Parameters:

  • cinfo['acctid'] - The account to validate the password on

  • cinfo['oldpw'] - The password to check

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

  • ACOperationNotSupported 2

  • ACInvalidUser 7

  • ACAccessDenied 11

  • ACVerifyFailed 14

  • ACPasswordLocked 26

  • ACPasswordExpired 27

  • ACAccountExpired 28

  • ACAccountDisabled 29

Remarks:

If this operation is not defined the verify operation will automatically be called instead

Change Password

Verifies the old password for an account, if successful the password is then changed to a new value.

Signature: change(cinfo)

Parameters:

  • cinfo['acctid'] - The account the password should be changed on

  • cinfo['newpw'] - The new password that should be set

  • cinfo['oldpw'] - The old password that should be verified

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

  • ACOperationNotSupported 2

  • ACInvalidUser 7

  • ACAccessDenied 11

  • ACVerifyFailed 14

  • ACPasswordLocked 26

  • ACPasswordExpired 27

  • ACAccountExpired 28

  • ACAccountDisabled 29

Expire Password

Expires the password for an account

Signature: def expirepw(cinfo)

Parameters:

  • cinfo['acctid'] - The account the password should be expired on

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

  • ACOperationNotSupported 2

  • ACInvalidUser 7

Is Password Expired

Checks if the password is expired on an account

Signature: def ispwexpired(cinfo)

Parameters:

  • cinfo['acctid'] - The account the password should be checked on

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

  • ACOperationNotSupported 2

  • ACInvalidUser 7

Remarks:

The agent.isPwExpired callback should be used to return the status of the password. See the agent.isPwExpired callback page for full details.

Reset

Sets the password for an account to a new value. This function will also unlock the account and unexpire the password.

  • Signature: def reset(cinfo)

Parameters:

  • cinfo['acctid'] - The account the password reset should be performed on

  • cinfo['newpw'] - The new password that should be set

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

  • ACOperationNotSupported 2

  • ACInvalidUser 7

Reset Expire Password

Sets the password for an account to a new value. This function will also expire the new password.

Signature: def resetexpirepw(cinfo)

Parameters:

  • cinfo['acctid'] - The account the password should be reset and expired on

  • cinfo['newpw'] - The new password that should be set

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

  • ACOperationNotSupported 2

  • ACInvalidUser 7

Unexpire Password

Unexpire the password for an account.

Signature: def unexpirepw(cinfo)

Parameters:

  • cinfo['acctid'] - The account the password should be unexpired on

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

  • ACOperationNotSupported 2

  • ACInvalidUser 7

Verify Password

Validates if a password is valid for a specified account

Signature: verify(cinfo)

Parameters:

  • cinfo['acctid'] - The account to validate the password on

  • cinfo['oldpw'] - The password to check

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

  • ACOperationNotSupported 2

  • ACInvalidUser 7

  • ACAccessDenied 11

  • ACVerifyFailed 14

  • ACPasswordLocked 26

  • ACPasswordExpired 27

  • ACAccountExpired 28

  • ACAccountDisabled 29

Verify Reset Password

Validates if a password is valid for a specified account, resetting the password if it is not. This function will also unlock the account and unexpire the password if required.

Signature: verifyreset(cinfo)

Parameters:

  • cinfo['acctid'] - The account to be performing the password operations on

  • cinfo['newpw'] - The password to be verified and set

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

  • ACOperationNotSupported 2

  • ACInvalidUser 7

  • ACAccessDenied 11

  • ACVerifyFailed 14

  • ACPasswordLocked 26

  • ACPasswordExpired 27

  • ACAccountExpired 28

  • ACAccountDisabled 29

Remarks:

If this operation is not defined other operations will be automatically called instead. The priority for fallback operations is:

  • adminverify operation, followed by a reset operation if the password fails to be verified

  • verify operation, followed by a reset operation if the password fails to be verified and the adminverify operation is not defined

  • reset operation, if neither the verify operation nor the adminverify operation is defined

In this section: