Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › WS-Federation Resource Partner Methods

WS-Federation Resource Partner Methods

AddAttribute Method—Adds Attribute to Resource Partner

The AddAttribute method adds an attribute to the WS-Federation Resource Partner.

Syntax

The AddAttribute method has the following format:

Netgerity::PolicyMgtWSFEDResourcePartner‑>AddAttribute(attrNameFormat, value)

Parameters

The AddAttribute method accepts the following parameters:

attrNameFormat (int)

Specifies one of the following attribute types:

• WSFEDRP_EMAILADDRESS
• WSFEDRP_UPN
• WSFEDRP_COMMON
• WSFEDRP_GROUP
• WSFEDRP_NAMEVALUE

  value (string)

Specifies an attribute value in one of the following formats:

• Static: variableName = value

  Note: The value's format must match the attribute's type, unless the type is WSFEDRP_NAMEVALUE. In this case, the value can be in any format.

• User Attribute: variableName = <%userattr="AttrName"%>
• DN Attribute: variableName = <#dn="DNSpec" attr="AttrName"#>

  Note: To allow SiteMinder to retrieve DN attributes from a nested group, preface DNSpec with an exclamation point (!), as follows: dn="!ou=People,o=security.com"

• Active Response

Return Value

The AddAttribute method returns one of the following values:

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

AddUser Method—Adds User to Resource Partner

The AddUser method adds a user to the WS-Federation Resource Partner.

Syntax

The AddUser method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>AddUser(user)

Parameters

The AddUser method accepts the following parameter:

user (PolicyMgtUser object)

Specifies the user to add to the Resource Partner.

Return Value

The AddUser method returns one of the following values:

• value = 0

  Specifies that the method is successful.

• value = -1

  Specifies that the method is unsuccessful.

CreateIPConfigHostName Method—Creates Object Based on Specified Host

The CreateIPConfigHostName method creates an IP configuration object for the WS-Federation Resource Partner based on the specified host name. This method creates an IP address restriction for the assertion generation policy. With this address restriction, only assertions generated from the specified host are accepted.

Syntax

The CreateIPConfigHostName method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>CreateIPConfigHostName(hostName)

Parameters

The CreateIPConfigHostName method accepts the following parameter:

hostName (string)

Specifies the name of the host where assertions must originate.

Return Value

The CreateIPConfigHostName method returns one of the following values:

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

CreateIPConfigSingleHost Method—Creates Object Based on Single Address

The CreateIPConfigSingleHost method creates an IP configuration object for the WS-Federation Resource Partner based on the specified IP address. This method creates an IP address restriction for the assertion generation policy. With this address restriction, only assertions generated from the specified IP address are accepted.

Syntax

The method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>CreateIPConfigSingleHost(ipAddr)

Parameters

The CreateIPConfigSingleHost method accepts the following parameter:

ipAddr (string)

Specifies the IP address where assertions must originate.

Return Value

The CreateIPConfigSingleHost method returns one of the following values:

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

CreateIPConfigSubnetMask Method—Creates Object Based on Subnet Address

The CreateIPConfigSubnetMask method creates an IP configuration object for the WS-Federation Resource Partner based on the specified IP address and subnet mask. This method creates an IP address restriction for the assertion generation policy. With this address restriction, only assertions generated from the subnet address are accepted. The subnet address is derived from the specified IP address and subnet mask.

Syntax

The CreateIPConfigSubnetMask method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>CreateIPConfigSubnetMask(ipAddr, subnetMask)

Parameters

The CreateIPConfigSubnetMask method accepts the following parameters:

ipAddr (string)

Specifies the IP address used to derive the subnet address.

subnetMask (unsigned long)

Specifies the subnet mask used to derive the subnet address.

Note: For more information about the subnet mask, see the method PolicyMgtPolicy‑>CreateIPConfigSubnetMask.

Return Value

The CreateIPConfigSubnetMask method returns one of the following values:

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

DeleteIPConfig Method—Deletes Specified IP Configuration Object

The DeleteIPConfig method deletes the specified IP configuration object.

Syntax

The DeleteIPConfig method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>DeleteIPConfig(IPConfig)

Parameters

The DeleteIPConfig method accepts the following parameter:

IPConfig (PolicyMgtIPConfig object)

Specifies the IP configuration object to delete.

Return Value

The DeleteIPConfig method returns one of the following values:

• value = 0

  Specifies that the method is successful.

• value = -1

  Specifies that the method is unsuccessful.

GetAllAttributes Method—Retrieves All Attributes for Resource Partner

The GetAllAttributes method retrieves all attributes defined for the WS-Federation Resource Partner.

Syntax

The GetAllAttributes method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>GetAllAttributes()

Parameters

The GetAllAttributes method accepts no parameters.

Return Value

The GetAllAttributes method returns one of the following values:

• PolicyMgtWSFEDRPAttr (array)
• undef if the call is unsuccessful

GetAllIPConfigs Method—Retrieves All IP Configuration Objects for Service Provider

The GetAllIPConfigs method retrieves all IP configuration objects for the Service Provider.

Syntax

The GetAllIPConfigs method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>GetAllIPConfigs()

Parameters

The GetAllIPConfigs method accepts no parameters.

Return Value

The GetAllIPConfigs method returns one of the following values:

• PolicyMgtIPConfig (array)
• undef if no IP configuration objects are found

GetAllUsers Method—Retrieves All Users Associated with Resource Partner

The GetAllUsers method retrieves all users associated with the WS-Federation Resource Partner. If a user directory is specified, this method only returns the users associated with the specified directory.

Syntax

The GetAllUsers method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>GetAllUsers([userDir])

Parameters

The GetAllUsers method accepts the following parameter:

userDir (PolicyMgtUserDir object)

(Optional) Specifies only those users associated with the user directory.

Return Value

The GetAllUsers method returns one of the following values:

• PolicyMgtUser (array)
• undef if no users are found or an error occurs

Property Method—Sets or Retrieves Resource Partner Property

The Property method sets or retrieves the value of the specified WS-Federation Resource Partner property. For a list of metadata properties, see the WS-Federation Property Reference in this guide.

Note: After modifying one or more properties, call Save to write the changes to the policy store.

Syntax

The Property method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>Property(name, [newvalue])

Parameters

The Property method accepts the following parameters:

name (string)

Specifies the property to set or retrieve.

newvalue (string)

(Optional) Specifies a new value for the Resource Partner property.

Return Value

The Property method returns one of the following values:

• value

  Specifies the new or existing value of the property.

• undef

  Specifies that the call is unsuccessful.

RemoveAtrribute Method--Removes an Attribute from a WSFED Resource Partner

The RemoveAttribute method removes an attribute from the WS-Federation Resource Partner.

Syntax

The RemoveAttribute method has the following format:

Netgerity::PolicyMgtWSFEDResourcePartner‑>RemoveAttribute(attrName)

Parameters

The RemoveAttribute method accepts the following parameter:

attrName (PolicyMgtWSFEDRPAttr)

Specifies the attribute to remove.

Return Value

The RemoveAttribute method returns one of the following values:

• 0 on success
• -1 on failure

RemoveUser Method—Removes Specified User from Resource Partner

The RemoveUser method removes the specified user from the WS-Federation Resource Partner.

Syntax

The RemoveUser method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>RemoveUser(user)

Parameters

The RemoveUser method accepts the following parameter:

user (PolicyMgtUser object)

Specifies the user to remove from the Resource Partner.

Return Value

The RemoveUser method returns one of the following values:

• value = 0

  Specifies that the method is successful.

• value = -1

  Specifies that the method is unsuccessful.

Save Method—Saves Resource Partner's Metadata

The Save method writes the WS-Federation Resource Partner's metadata to the policy store. To modify the metadata, call the PolicyMgtWSFEDResourcePartner‑>Property method. Then, call Save to save the changes.

Syntax

The Save method has the following format:

Netegrity::PolicyMgtWSFEDResourcePartner‑>Save()

Parameters

The Save method accepts no parameters.

Return Value

The Save method returns one of the following values:

• value = 0

  Specifies that the method is successful.

• value = -1

  Specifies that the method is unsuccessful.

• value = -4

  Specifies that the user lacks the privileges required to save the changes.

• value = -10

  Specifies that the path and class are empty.