Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › User Directory Methods › RequireCredentials Method—Sets or Retrieves Whether Credentials Are Required

RequireCredentials Method—Sets or Retrieves Whether Credentials Are Required

The RequireCredentials method sets or retrieves the flag that specifies whether SiteMinder is required to check user credentials.

Syntax

The RequireCredentials method has the following format:

Netegrity::PolicyMgtUserDir‑>RequireCredentials([credFlag])

Parameters

The RequireCredentials method accepts the following parameter:

credFlag (int)

(Optional) Specifies whether SiteMinder is required to check user credentials:

• value = 1 (credentials required)
• value = 0 (credentials are not required)

Return Value

The RequireCredentials method returns the new or existing value for the require credentials flag:

• value = 1

  Specifies that credentials are required.

• value = 0

  Specifies that credentials are not required.

• value = -1

  Specifies that the call is unsuccessful.