{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"611666b2-ade4-479c-9183-a98c5b82baa6"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"248f1df2-0e97-4bae-b61c-49263212fb5c"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"A set of built-in transcoders supporting SAML 2.0 ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" objects is provided that support the most frequently needed value types. Most of them support a common set of properties, documented below; a few other properties are defined for specific transcoder types. Since they largely all do the same thing in the same way, they're documented here together.","type":"text"}]},{"type":"paragraph","content":[{"text":"A particular property of the SAML schema is that ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" both carry zero or more ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" children, so it's allowed in general for the transcoders to be asked to generate objects with no values in either direction but may be inappropriate and prevented in specific cases.","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" elements can be mapped to and from ","type":"text"},{"text":"IdPRequestedAttribute","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-idp.cgi/net.shibboleth.idp.attribute.IdPRequestedAttribute"}}]},{"text":" objects with the isRequired property correspondingly set.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Common Properties","type":"text"}]},{"type":"paragraph","content":[{"text":"In addition to the ","type":"text"},{"text":"generic properties","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/IDP4/pages/1272054333#TranscodingRuleConfiguration-GenericandRequiredProperties"}}]},{"text":", all SAML 2 transcoders support the following:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"a736cdfc-4684-4c54-a3fd-7d57cee73ede"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[185.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[62.0]},"content":[{"type":"paragraph","content":[{"text":"Req?","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[91.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Default","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[426.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[185.0]},"content":[{"type":"paragraph","content":[{"text":"saml2.name","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[62.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Y","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[91.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[426.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"Name","type":"text","marks":[{"type":"code"}]},{"text":" to map to and from","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[185.0]},"content":[{"type":"paragraph","content":[{"text":"saml2.nameFormat","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[62.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[91.0]},"content":[{"type":"paragraph","content":[{"text":"URI","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"urn:oasis:names:tc:SAML:2.0:attrname-format:uri","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[426.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"NameFormat","type":"text","marks":[{"type":"code"}]},{"text":" to map to and from","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[185.0]},"content":[{"type":"paragraph","content":[{"text":"saml2.friendlyName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[62.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[91.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"When encoding, the input IdPAttribute's ID","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[426.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"FriendlyName","type":"text","marks":[{"type":"code"}]},{"text":" to encode","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[185.0]},"content":[{"type":"paragraph","content":[{"text":"saml2.encodeType","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[62.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[91.0]},"content":[{"type":"paragraph","content":[{"text":"Boolean","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"true ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[426.0]},"content":[{"type":"paragraph","content":[{"text":"Whether to encode values with an ","type":"text"},{"text":"xsi:type","type":"text","marks":[{"type":"code"}]},{"text":" attached","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Note the default for “saml2.nameFormat” above. If your desired inbound or outbound syntax does not include the ","type":"text"},{"text":"NameFormat","type":"text","marks":[{"type":"code"}]},{"text":" XML Attribute or relies on a different value, then you MUST set it explicitly in the rule.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Transcoder Types","type":"text"}]},{"type":"paragraph","content":[{"text":"There are 4 built-in subtypes of SAML 2 transcoders, as follows. Each one is predefined as a Spring bean for use in rules using the \"short\" name of the class, as enumerated in the ","type":"text"},{"text":"TranscodingRuleConfiguration","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/IDP4/pages/1272054333"}}]},{"text":" reference section.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SAML2StringAttributeTranscoder","type":"text"}]},{"type":"paragraph","content":[{"text":"The simplest and most commonly used transcoder, it supports encoding and decoding internal values from and to the ","type":"text"},{"text":"StringAttributeValue","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-idp.cgi/net.shibboleth.idp.attribute.StringAttributeValue"}}]},{"text":" class. It supports no additional properties.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SAML2ScopedStringAttributeTranscoder","type":"text"}]},{"type":"paragraph","content":[{"text":"It supports encoding and decoding internal values from and to the ","type":"text"},{"text":"ScopedStringAttributeValue","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-idp.cgi/net.shibboleth.idp.attribute.ScopedStringAttributeValue"}}]},{"text":" class. It supports the following additional properties (all optional):","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"04b0f5b8-69e7-49b9-9a8c-767a59389a68"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[220.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[171.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[86.0]},"content":[{"type":"paragraph","content":[{"text":"Default","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[220.0]},"content":[{"type":"paragraph","content":[{"text":"saml2.scopeType","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[171.0]},"content":[{"type":"paragraph","content":[{"text":"\"inline\" or \"attribute\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[86.0]},"content":[{"type":"paragraph","content":[{"text":"\"inline\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"paragraph","content":[{"text":"The \"style\"/syntax with which to encode and decode the scope portion","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[220.0]},"content":[{"type":"paragraph","content":[{"text":"saml2.scopeAttributeName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[171.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[86.0]},"content":[{"type":"paragraph","content":[{"text":"Scope","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"paragraph","content":[{"text":"The name of the XML attribute to encode and decode the scope portion when saml2.scopeType is \"attribute\"","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[220.0]},"content":[{"type":"paragraph","content":[{"text":"saml2.scopeDelimiter","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[171.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[86.0]},"content":[{"type":"paragraph","content":[{"text":"@","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"paragraph","content":[{"text":"The character(s) to use to separate the value and scope when saml2.scopeType is \"inline\"","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SAML2DateTimeAttributeTranscoder ","type":"text"},{"text":"4.3","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"paragraph","content":[{"text":"It supports encoding and decoding internal values from and to the ","type":"text"},{"text":"DateTimeAttributeValue","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-idp.cgi/net.shibboleth.idp.attribute. DateTimeAttributeValue"}}]},{"text":" class. It supports the following additional properties (all optional):","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"e345018f-f401-420d-8aee-1924c00f465c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[237.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[79.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"Default","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[757.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[237.0]},"content":[{"type":"paragraph","content":[{"text":"saml2.epochUnits","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[79.0]},"content":[{"type":"paragraph","content":[{"text":"“s“ or “ms”","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"“s”","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[757.0]},"content":[{"type":"paragraph","content":[{"text":"When decoding, controls the handling of integer values (or strings in that form) when converting to an ","type":"text"},{"text":"Instant","type":"text","marks":[{"type":"link","attrs":{"href":"https://shibboleth.net/cgi-bin/java-jdk.cgi/java/time/Instant"}}]},{"text":". The default (“s”) is to handle the value as seconds, while “ms” means to handle as milliseconds. Java tends to deal in the latter but the traditional handling (e.g., C/C++) tend to be in seconds.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SAML2ByteAttributeTranscoder","type":"text"}]},{"type":"paragraph","content":[{"text":"It supports encoding and decoding internal values from and to the ","type":"text"},{"text":"ByteAttributeValue","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-idp.cgi/net.shibboleth.idp.attribute.ByteAttributeValue"}}]},{"text":" class, with a base64 transform applied. It supports no additional properties.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SAML2XMLObjectAttributeTranscoder","type":"text"}]},{"type":"paragraph","content":[{"text":"It supports encoding and decoding internal values from and to the ","type":"text"},{"text":"XMLObjectAttributeValue","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-idp.cgi/net.shibboleth.idp.attribute.XMLObjectAttributeValue"}}]},{"text":" class. It supports the following additional properties (all optional):","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"93753b5a-ccac-490e-8867-104ccfe1f2e8"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[237.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[79.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"Default","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[757.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[237.0]},"content":[{"type":"paragraph","content":[{"text":"saml2.includeAttributeValue","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[79.0]},"content":[{"type":"paragraph","content":[{"text":"Boolean","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[757.0]},"content":[{"type":"paragraph","content":[{"text":"When decoding, controls whether the decoded XMLObject is actually the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element itself, or its child element","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported