SAML 2 Scoped String Attribute Encoder

The SAML 2 scoped string attribute encoder creates SAML 2 <Attribute> elements from resolved scoped attributes with <AttributeValue> elements for each value. The content of these <AttributeValue> elements are strings and the scope value of the containing <AttributeDefinition>. The method of combining this scope value is configurable. This encoder is only used for SAML 2 messages and will be ignored when the IdP is answering other protocol messages.

Define the Encoder

Attribute encoders are defined in a <resolver:AttributeDefinition> after all <resolver:Dependency>.

To define a new SAML 2 scoped string attribute encoder, create a <resolver:AttributeEncoder xsi:type="SAML2ScopedString" xmlns="urn:mace:shibboleth:2.0:attribute:encoder"> with the following required attributes:

• name - this becomes the Name attribute on the created SAML 2 <Attribute> element

and the following optional attributes:

• nameFormat - this becomes the NameFormat attribute on the created SAML 2 <Attribute> element (default value: urn:oasis:names:tc:SAML:2.0:attrname-format:uri)
• friendlyName - this becomes the FriendlyName attribute on the created SAML 2 <Attribute> element
• scopeType - defines how the scope value should be combined with the base attribute value; valid values are inline and attribute (default value: inline)
• scopeAttribute - when using a scopeType value of attribute, this defines the name of the attribute which will be added to the created SAML 2 <AttributeValue> to convey the scope value (default value: Scope)
• scopeDelimiter - when using a scopeType value of inline, this defines the string used to separate the attribute value from the scope value (default value @)

<resolver:AttributeDefinition id="UNIQUE_ID" xsi:type="ad:Scoped">

     <resolver:Dependency ref="DEFINITION_ID_1" />
     <resolver:Dependency ref="DEFINITION_ID_2" />
     <resolver:Dependency ref="CONNECTOR_ID_3" />
     <resolver:Dependency ref="CONNECTOR_ID_4" />

     <resolver:AttributeEncoder xsi:type="SAML2ScopedString" xmlns="urn:mace:shibboleth:2.0:attribute:encoder"
                                name="ATTRIBUTE_NAME_1" />

     <resolver:AttributeEncoder xsi:type="SAML2ScopedString" xmlns="urn:mace:shibboleth:2.0:attribute:encoder"
                                name="ATTRIBUTE_NAME_2"
                                nameFormat="ATTRIBUTE_NAME_FORMAT"
                                friendlyName="ATTRIBUTE_FRIENDLY_NAME" 
                                scopeType="attribute" 
                                scopeAttribute="ATTRIBUTE_SCOPE_ATTRIBUTE_NAME" />

     <resolver:AttributeEncoder xsi:type="SAML2ScopedString" xmlns="urn:mace:shibboleth:2.0:attribute:encoder"
                                name="ATTRIBUTE_NAME_3"
                                nameFormat="ATTRIBUTE_NAME_FORMAT"
                                friendlyName="ATTRIBUTE_FRIENDLY_NAME" 
                                scopeType="inline" 
                                scopeDelimiter="#" />

</resolver:AttributeDefinition>