The SAML2String attribute encoder encodes a string-valued IdPAttribute as a SAML 2 Attribute. This is the most common encoder used with SAML 2.

Schema Name and Location

This xsi:type is defined by the urn:mace:shibboleth:2.0:resolver schema^3.3, which is located at http://shibboleth.net/schema/idp/shibboleth-attribute-resolver.xsd .

Prior to V3.3 supplied plugins were defined by a schema type (xsi:type) in the urn:mace:shibboleth:2.0:encoder schema , which is located at http://shibboleth.net/schema/idp/shibboleth-attribute-encoder.xsd. This is still supported, but every element or type in the urn:mace:shibboleth:2.0:encoder schema has an identically named version in the urn:mace:shibboleth:2.0:resolver schema.

Attributes

Common Attributes

Name	Type	Default	Description
`encodeType`	boolean	true	Controls whether the output form will contain an encoder-specific indication of the data type of the values. In XML, this takes the form of `xsi:type` attributes, which greatly bloat the size and generally should be avoided for string-valued data. For compatibility with V2, the default is to continue to output the information, but we suggest disabling it in newer deployments and after testing against existing services.
`activationConditionRef`	Bean Reference		Bean ID of a condition bean that determines whether the encoder should be active, described further here. Mutually exclusive with `relyingParties`
`relyingParties` ^3.4	space-delimited list		List of entity IDs for which this Attribute Encoder should be active. Mutually exclusive with `activationConditionRef`

Specific Attributes

Name	Type	Req?	Default	Description
name	string	Y		Value to put into the "`Name`" attribute of the output `<AttributeValue>` elements
nameFormat	string		`urn:oasis:names:tc:SAML:2.0:attrname-format:uri`	Value to put into the "`NameForma`t" attribute of the output `<AttributeValue>` elements
friendlyName	string			Value to put into the "`FriendlyName`" attribute of the output `<AttributeValue>` elements

Example

<AttributeEncoder xsi:type="SAML2String" name="urn:oid:2.16.840.1.113730.3.1.241" friendlyName="displayName" encodeType="false" />

Browser not supported