Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › SAML 2.0 Service Provider Methods › AddAttribute Method—Adds an Attribute to the SAML 2.0 Service Provider

AddAttribute Method—Adds an Attribute to the SAML 2.0 Service Provider

The AddAttribute method adds an attribute to the SAML 2.0 Service Provider.

Syntax

The AddAttribute method has the following format:

Netegrity::PolicyMgtSAMLServiceProvider‑>AddAttribute(attrNameFormat, value, nEncrypted, nMode)

Parameters

The AddAttribute method accepts the following parameters:

attrNameFormat (int)

Specifies one of the following attribute formats, as defined in the SAML 2.0 standard:

• SAMLSP_UNSPECIFIED (Value=0)
• SAMLSP_URI (Value=1)
• SAMLSP_BASIC (Value=2)

  value (string)

Specifies the value specification for the attribute. This value specification appears in the Name Value Pair column of the SiteMinder SAML Service Provider Properties Dialog. The format of the value specification depends upon the kind of attribute you are adding -- Static, User Attribute, or DN Attribute:

• Static attributes:

  variableName=value

• User attributes:

  variableName=<%userattr="AttrName"%>

• DN attributes:

  variableName=<#dn="DNSpec" attr="AttrName"#>

  To allow SiteMinder to retrieve DN attributes from a nested group, begin DNSpec with an exclamation mark ( ! ) -- for example:

  dn="!ou=People,o=security.com"

  nEncrypted (int)

Specifies whether the attribute is encrypted. If non-zero, the attribute is encrypted after being included in the assertion.

nMode (int)

Specifies the retrieval mode of this attribute, which is one of the following:

• SAMLSP_SSO
• SAMLSP_Attribute

Return Value

The AddAttribute method returns one of the following values:

• A PolicyMgtSAMLSPAttr object
• undef if the call is unsuccessful

Remarks

A SAML 2.0 attribute contains information about a principal who is trying to access a resource on the Service Provider -- for example, the principal's user DN.

The defined attribute is included in an attribute statement for all SAML 2.0 assertions that are produced for this Service Provider.