Scripting and Programming Guides › Scripting Guide for Perl › CLI Policy Management Methods › Session Methods › CreateSAMLAffiliation Method—Creates SAML 2.0 Affiliation Object

CreateSAMLAffiliation Method—Creates SAML 2.0 Affiliation Object

The CreateSAMLAffiliation method creates a SAML 2.0 affiliation object. A SAML 2.0 affiliation is a set of entities that share a single federated namespace of unique Name IDs for principals. To modify the properties of an existing SAML affiliation, call the method PolicyMgtSAMLAffiliation‑>Property. For more information about SAML 2.0 affiliations, see Remarks and the Federation Security Services Guide.

Syntax

The CreateSAMLAffiliation method has the following format:

Netegrity::PolicyMgtSession‑>CreateSAMLAffiliation(propsHash_ref)

Parameters

The CreateSAMLAffiliation method accepts the following parameter:

propsHash_ref (hash)

Specifies a reference to a hashtable of metadata properties for the SAML 2.0 affiliation.

Example: \%myhash

Return Value

The CreateSAMLAffiliation method returns one of the following values:

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

Remarks

The SAML 2.0 affiliation properties are grouped in the Policy Server User Interface as follows:

General Properties

SAML_NAME

SAML_DESCRIPTION

SAML_KEY_AFFILIATION_ID

SAML_MAJOR_VERSION

SAML_MINOR_VERSION

SAML_OID

Name IDs Tab

SAML_SP_NAMEID_FORMAT

SAML_SP_NAMEID_TYPE

SAML_SP_NAMEID_STATIC

SAML_SP_NAMEID_ATTRNAME

SAML_SP_NAMEID_DNSPEC

UsersTab

SAML_IDP_XPATH

SAML_IDP_LDAP_SEARCH_SPEC

SAML_IDP_ODBC_SEARCH_SPEC

SAML_IDP_WINNT_SEARCH_SPEC

SAML_IDP_CUSTOM_SEARCH_SPEC

SAML_IDP_AD_SEARCH_SPEC

For more information, see the SAML 2.0 Property Reference in this guide.