Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Session Methods › WSFEDAuthSchemeProperties Method—Sets or Retrieves WS-Federation Properties

WSFEDAuthSchemeProperties Method—Sets or Retrieves WS-Federation Properties

The WSFEDAuthSchemeProperties method sets or retrieves the WS-Federation metadata properties in an existing WS-Federation authentication scheme. For a complete list of WS-Federation metadata properties, see the method PolicyMgtSession‑>CreateWSFEDAuthScheme.

Syntax

The WSFEDAuthSchemeProperties method has the following format:

Netegrity::PolicyMgtSession‑>WSFEDAuthSchemeProperties(scheme, propsHash_ref)

Parameters

The WSFEDAuthSchemeProperties method accepts the following parameters:

scheme (PolicyMgtAuthScheme object)

Specifies the authentication scheme whose WS-Federation metadata properties are set or retrieved.

propsHash_ref (hash)

Specifies a reference to a hashtable of metadata properties to set or retrieve.

Return Value

The WSFEDAuthSchemeProperties method returns one of the following values:

• value = 0

  Specifies that the method is successful.

• value = -1

  Specifies that the method is unsuccessful.

Remarks

When the hashtable is empty, the WSFEDAuthSchemeProperties method retrieves all metadata properties. You can define an empty hashtable as follows:

%myhash=();

Then, you can reference the empty hashtable as follows:

\%myhash

Finally, you can pass the hashtable reference to the WSFEDAuthSchemeProperties method through the propsHash_ref parameter.