Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Session Methods › GetAuthScheme Method—Retrieves Authentication Scheme Object

GetAuthScheme Method—Retrieves Authentication Scheme Object

The GetAuthScheme method retrieves the specified authentication scheme object. Existing authentication schemes are specified by name. To create a new authentication scheme, use this method to retrieve the type of authentication scheme object or template upon which you want the new scheme to be based. Then, pass the resulting object to the PolicyMgtSession‑>CreateAuthScheme method in the schemeTemplate parameter. For information about creating a SAML 2.0 authentication scheme, see the method PolicyMgtSession‑>CreateSAMLAuthScheme.

Syntax

The GetAuthScheme method has the following format:

Netegrity::PolicyMgtSession‑>GetAuthScheme(schemeName)

Parameters

The GetAuthScheme method accepts the following parameter:

schemeName (string)

Specifies one of the following:

• The name of an existing authentication scheme.
• The type of authentication scheme that you want to create:
  • Anonymous Template
  • Basic over SSL Template
  • Basic Template
  • CRYPTOCard RB-1 Template
  • Custom Template
  • HTML Form Template
  • Impersonation Template
  • MS Passport Template
  • RADIUS CHAP/PAP Template
  • RADIUS Server Template
  • SafeWord HTML Form Template
  • SafeWord Template
  • SAML Artifact Template

    Note: This template requires Federation Security Services.

  • SAML POST Template

    Note: This template requires Federation Security Services.

  • SAML 2.0 Template

    Note: This template requires Federation Security Services.

  • SecurID HTML Form Template
  • SecurID Template
  • TeleID Template
  • Windows Authentication Template
  • X509 Client Cert and Basic Template
  • X509 Client Cert and Form Template
  • X509 Client Cert or Basic Template
  • X509 Client Cert or Form Template
  • X509 Client Cert Template

Return Value

The GetAuthScheme method returns one of the following values:

• PolicyMgtAuthScheme (object)
• undef if the call is unsuccessful or the specified authentication scheme does not exist