The Shibboleth IdP V4 software has reached its End of Life and is no longer supported. This documentation is available for historical purposes only. See the IDP5 wiki space for current documentation on the supported version.

AttributeEncoderPluginConfiguration

Namespace: urn:mace:shibboleth:2.0:resolver
Schema: http://shibboleth.net/schema/idp/shibboleth-attribute-resolver.xsd

Overview

Attribute encoders convert the internal representation of an IdPAttribute into a particular protocol format. The supported encoders currently support SAML 1, SAML 2, and CAS representations. The mechanism is inherently limited to XML-based output formats.

Attribute encoders are specified with the xsi:type attribute within the <AttributeEncoder> element.

General purpose attribute encoding is best achieved by using the Attribute Registry.  Explicit per-attribute encoding continues to be useful when you want to associate an ActivationCondition with the encoder (though this is also possible via rules in the registry).

Note that a source of confusion is that because of the changes to how this code operates, when you add or remove encoders to your resolver configuration, the changes won't take effect until/unless the AttributeRegistryConfiguration is reloaded.

AttributeEncoder Plugin Types

xsi:type

Function

xsi:type

Function

SAML2String

Encodes an IdPAttribute with simple string values as a SAML 2 Attibute.

SAML2ScopedString

Encodes an IdPAttribute with scoped values as a SAML 2 Attibute.

SAML2DateTime 4.3

Encodes an IdPAttribute with date/time values as a SAML 2 Attribute.

SAML2XMLObject

Encodes an IdPAttribute with complex XML-based values as a SAML 2 Attribute.

SAML2Base64

Encodes an IdPAttribute with binary values as a SAML 2 Attribute.

SAML1String

Encodes an IdPAttribute with simple string values as a SAML 1 Attibute.

SAML1ScopedString

Encodes an IdPAttribute with scoped values as a SAML 1 Attibute.

SAML1XMLObject

Encodes an IdPAttribute with complex XML-based values as a SAML 1 Attribute.

SAML1Base64

Encodes an IdPAttribute with binary values as a SAML 1 Attribute.

Reference

The following attributes are common to all encoders:

The following child element is common to all encoders: