Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Session Methods › CreateWSFEDAuthScheme Method—Creates WS-Federation Authentication Scheme

CreateWSFEDAuthScheme Method—Creates WS-Federation Authentication Scheme

The CreateWSFEDAuthScheme method creates an instance of a WS-Federation authentication scheme and sets the authentication scheme's properties.

Syntax

The CreateWSFEDAuthScheme method has the following format:

Netegrity::PolicyMgtSession‑>CreateWSFEDAuthScheme(name, propsHash[, desc][, level])

Parameters

The CreateWSFEDAuthScheme method accepts the following parameters:

name (string)

Specifies the name of the WS-Federation authentication scheme.

propsHash (hashtable)

Specifies a reference to the hashtable of WS-Federation authentication scheme properties to set.

Note: For a complete list of WS-Federation authentication scheme properties, see Remarks.

desc (string)

(Optional) Specifies a description of the authentication scheme.

level (int)

(Optional) Specifies the authentication scheme level.

Return Value

The CreateWSFEDAuthScheme method returns one of the following values:

• PolicyMgtAuthScheme (object)
• undef if the call is unsuccessful

Remarks

The WS-Federation authentication scheme properties are grouped in the FSS Administrative UI as follows:

• General Properties

  WSFED_NAME

  WSFED_DESCRIPTION

• Scheme Setup Tab

  WSFED_KEY_APID

  WSFED_RPID

  WSFED_SKEW_TIME

  WSFED_DISABLE_SIGNATURE_PROCESSING

  WSFED_DSIG_VERINFO_ALIAS

• Additional Configuration, Users Tab

  WSFED_AP_XPATH

  WSFED_AP_LDAP_SEARCH_SPEC

  WSFED_AP_ODBC_SEARCH_SPEC

  WSFED_AP_WINNT_SEARCH_SPEC

  WSFED_AP_CUSTOM_SEARCH_SPEC

  WSFED_AP_ADD_SEARCH_SPEC

• Additional Configuration, SSO Tab

  WSFED_AP_SSO_REDIRECT_MODE

  WSFED_AP_SSO_DEFAULT_SERVICE

  WSFED_AP_SSO_TARGET

  WSFED_ENFORCE_SINGLE_USE_POLICY

• Additional Configuration, Signout Tab

  WSFED_AP_SLO_ENABLED

  WSFED_AP_SIGNOUT_URL

• Additional Configuration, Advanced Tab

  WSFED_AP_PLUGIN_CLASS

  WSFED_AP_PLUGIN_PARAMS

  WSFED_AP_USER_NOT_FOUND_REDIRECT_URL

  WSFED_AP_USER_NOT_FOUND_REDIRECT_MODE

  WSFED_AP_FAILURE_REDIRECT_URL

  WSFED_AP_FAILURE_REDIRECT_MODE

  WSFED_AP_INVALID_REDIRECT_URL

  WSFED_AP_INVALID_REDIRECT_MODE