Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Session Methods › AddAttributeToSAMLScheme Method—Adds New Attribute to Authentication Scheme

AddAttributeToSAMLScheme Method—Adds New Attribute to Authentication Scheme

The AddAttributeToSAMLScheme method adds a new attribute to the SAML 2.0 authentication scheme definition.

Syntax

The AddAttributeToSAMLScheme method has the following format:

Netegrity::PolicyMgtSession‑>AddAttributeToSAMLScheme(scheme, AttrNameFormat, LocalName, Name)

Parameters

The AddAttributeToSAMLScheme method accepts the following parameters:

scheme (PolicyMgtAuthScheme object)

Specifies the SAML 2.0 authentication scheme.

AttrNameFormat (int)

Specifies the attribute type:

• SAMLSP_UNSPECIFIED
• SAMLSP_URI
• SAMLSP_BASIC

  LocalName (string)

Specifies the attribute's name as used locally.

Name (string)

Specifies the attribute's name as defined on the Attribute Authority.

Return Value

The AddAttributeToSAMLScheme method returns one of the following values:

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