Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › User Methods › DisableByAdmin Method—Sets or Retrieves Disabled-by-Administrator Flag

DisableByAdmin Method—Sets or Retrieves Disabled-by-Administrator Flag

The DisableByAdmin method sets or retrieves the disabled-by-administrator flag which specifies whether the user account is disabled by the administrator.

Syntax

The DisableByAdmin method has the following format:

Netegrity::PolicyMgtUser‑>DisableByAdmin([disableFlag])

Parameters

The DisableByAdmin method accepts the following parameter:

disableFlag (int)

(Optional) Specifies a new value for the disabled-by-administrator flag.

• value = 1

  Specifies that the user account is disabled by the administrator.

• value = 0

  Specifies that the user account is not disabled by the administrator.

  Note: The user account can be disabled for other reasons. For more information, see Remarks.

Return Value

The DisableByAdmin method returns the new or existing value for the disabled-by-administrator flag:

• value = 1

  Specifies that the user account is disabled by the administrator.

• value = 0

  Specifies that the user account is not disabled by the administrator.

  Note: The user account can be disabled for other reasons. For more information, see Remarks.

• value = -1

  Specifies that the call is unsuccessful.

Remarks

User accounts can be disabled for one or more of the following reasons:

• The administrator disabled the user account.
• Account inactivity exceeded the time allowed.

  For more information, see the method PolicyMgtUser‑>DisableInactive.

• The number of login failures exceeded the maximum allowed.

  For more information, see the method PolicyMgtUser‑>DisableMaxLoginFail.

• The password expired.

  For more information, see the method PolicyMgtUser‑>DisablePwdExpired.