Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Authentication Scheme Methods › IsUsedByAdmin Method—Determines whether the Scheme Authenticates Administrators

IsUsedByAdmin Method—Determines whether the Scheme Authenticates Administrators

The IsUsedByAdmin method determines whether the scheme should be used to authenticate administrators.

Syntax

The IsUsedByAdmin method has the following format:

Netegrity::PolicyMgtAuthScheme‑>IsUsedByAdmin([useAdminFlag])

Parameters

The IsUsedByAdmin method accepts the following parameter:

useAdminFlag (int)

(Optional) Specifies whether the scheme should be used to authenticate administrators:

• 1 to allow the scheme to be used for administrator authentication
• 0 to disallow the scheme to be used for administrator authentication

Return Value

The IsUsedByAdmin method returns one of the following values:

• 1 if the scheme can be used to authenticate administrators
• 0 if the scheme cannot be used to authenticate administrators
• -1 if the call was unsuccessful