Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Resource Methods

Resource Methods

GetAuthType Method—Retrieves the Type of Credentials Required

The GetAuthType method retrieves the type of credentials required for successful login to the resource or realm.

Syntax

The GetAuthType method has the following format:

Netegrity::AgentResource‑>GetAuthType()

Parameters

The GetAuthType method accepts no parameters.

Return Value

The GetAuthType method returns one of the following values:

• Sm_AuthApi_Cred_None (value = 0x00)

  Specifies that no credentials are required.

  Note: This authorization type is used for anonymous realms.

• Sm_AuthApi_Cred_Basic (value = 0x01)

  Specifies that a username and password are required.

• Sm_AuthApi_Cred_Digest (value = 0x02)

  Specifies that the username and password must be exchanged using the digest protocol.

• Sm_AuthApi_Cred_X509Cert (value = 0x04)

  Specifies that a full X.509 client certificate is required.

• Sm_AuthApi_Cred_X509CertUserDN (value = 0x08)

  Specifies that the user DN from an X.509 client certificate is required.

• Sm_AuthApi_Cred_X509CertIssuerDN (value = 0x10)

  Specifies that the issuer DN from an X.509 client certificate is required.

• Sm_AuthApi_Cred_CertOrBasic (value = 0x20)

  Specifies that a certificate is required, if available.

  Note: If a certificate is not available, a username and password are required.

• Sm_AuthApi_Cred_NTChalResp (value = 0x40)

  Specifies that the username and password must be exchanged using the NT challenge/response protocol.

• Sm_AuthApi_Cred_CertOrForm (value = 0x80)

  Specifies that either an X.509 certificate or a forms-based authentication scheme is required.

• Sm_AuthApi_Cred_SSLRequired (value = 0x01000000)

  Specifies that an SSL connection is required.

• Sm_AuthApi_Cred_FormRequired (value = 0x02000000)

  Specifies that the user must be redirected to an HTML form.

• Sm_AuthApi_Cred_AllowSaveCreds (value = 0x04000000)

  Specifies that the credentials can be saved for 30 days

  Note: When credentials are saved, users are not required to re-enter them each time they access a protected resource.

• Sm_AuthApi_Cred_PreserveSessionID (value = 0x08000000)

  Specifies that the Session ID be preserved for as long as the current session is valid.

• Sm_AuthApi_Cred_DoNotChallenge (value = 0x10000000)

  Specifies that the user not be challenged for credentials.

• undef

  Specifies that the resource is not protected.

IsProtected Method—Checks whether SiteMinder Is Protecting Resource

The IsProtected method checks whether SiteMinder is protecting the defined resource.

Syntax

The IsProtected method has the following format:

Netegrity::AgentResource‑>IsProtected()

Parameters

The IsProtected method accepts no parameters.

Return Value

The IsProtected method returns one of the following values:

• SM_AGENTAPI_YES (value = 1)

  Specifies that the resource is protected.

• SM_AGENTAPI_NO (value = 2)

  Specifies that the resource is not protected.

• SM_AGENTAPI_FAILURE (value = -1)

  Specifies that the Policy Server could not be reached.

• SM_AGENTAPI_TIMEOUT (value = -2)

  Specifies that the method timed out.

• SM_AGENTAPI_NOCONNECTION (value = -3)

  Specifies that initialization failed.