{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The RelyingPartyUIContext renders information about the relying party drawn from its metadata. This metadata generally allows language sensitive specification and the rpUIContext respects this. Specifically it searches for the best match against the (ordered list of) supported languages specified by the browser and failing that for the best match against the (ordered list) of fallback languages specified in ","type":"text"},{"text":"idp.properties","type":"text","marks":[{"type":"strong"}]},{"text":" as ","type":"text"},{"text":"idp.ui.fallbackLanguages","type":"text","marks":[{"type":"code"}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"3"}},"macroMetadata":{"macroId":{"value":"5b66d0d0-0b37-4e7a-aed5-a1939199ecbe"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"paragraph","content":[{"text":"In most cases the values are extracted from the Metadata of the relyingparty. The ","type":"text"},{"text":"SAML Metadata","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf"}}]},{"text":" and the ","type":"text"},{"text":"SAML Metadata Login and Discover UI Extensions","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-metadata-ui/v1.0/cs01/sstc-saml-metadata-ui-v1.0-cs01.pdf"}}]},{"text":" specifications provide the required details.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"$rpUIContext.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"contactEmail(type)","type":"text"}]},{"type":"paragraph","content":[{"text":"This returns the (language specific) URL which is the email address of the contact of the specified type (if it exists in the metadata for the relying party). The URL scheme is limited to","type":"text"},{"text":" http:","type":"text","marks":[{"type":"code"}]},{"text":",","type":"text"},{"text":" https: ","type":"text","marks":[{"type":"code"}]},{"text":"and","type":"text"},{"text":" mailto:. O","type":"text","marks":[{"type":"code"}]},{"text":"ther types will not render but will result in an error message in the log.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameter","type":"text"}]},{"type":"paragraph","content":[{"text":"Only one parameter can be provided, the type of the contact can be one of technical, support, administrative, billing, or other.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"#set ($email=$rpUIContext.contactEmail(support))\nContact the websites support team here","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"The email field is defined in the ","type":"text"},{"text":"SAML Metadata","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf"}}]},{"text":" specification.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"$rpUIContext.","type":"text"},{"text":"contactGivenName(type), ","type":"text"},{"text":"$rpUIContext.","type":"text"},{"text":"contactSurName(type), ","type":"text"}]},{"type":"paragraph","content":[{"text":"These return the (language specific) \"Given Name\" and \"Surname\" of the contact of the specified type (if it exists in the metadata for the relying party).","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameter","type":"text"}]},{"type":"paragraph","content":[{"text":"Only one parameter can be provided, the type of the contact can be one of technical, support, administrative, billing, or other.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"#set ($surname=$rpUIContext.contactSurName(billing))\n#set ($givenName=$rpUIContext.contactGiven(billing))\n#if ($givenName) \n #set ($name=$givenName $surname)\n#else\n #set ($name=$surname)\n#end\n#if ($name)\n\tBilling Contact name is given as $encoder.encodeForHTML($name)\n#else\n No Billing Contact name given.\n#end","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"The given name are surname are defined in the ","type":"text"},{"text":"SAML Metadata","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf"}}]},{"text":" specification.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"$rpUIContext.","type":"text"},{"text":"informationURL","type":"text"}]},{"type":"paragraph","content":[{"text":"This returns the (language specific) Information URL if it exists in the metadata extensions for the relying party. The URL scheme is limited to","type":"text"},{"text":" http:","type":"text","marks":[{"type":"code"}]},{"text":" and","type":"text","marks":[{"type":"code"}]},{"text":" https:. O","type":"text","marks":[{"type":"code"}]},{"text":"ther types will not render but will result in an error message in the log.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"#set ($infoURL=$rpUIContext.informationURL)\n#if ($infoURL) \n Information about this service can be found here\n#end","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"No parameter should be specified.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"The given name are surname are defined in the ","type":"text"},{"text":"SAML Metadata Login and Discover UI Extensions","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-metadata-ui/v1.0/cs01/sstc-saml-metadata-ui-v1.0-cs01.pdf"}}]},{"text":" specification.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"$rpUIContext.","type":"text"},{"text":"logo","type":"text"}]},{"type":"paragraph","content":[{"text":"This returns the \"best fit\" URL specified for the logo of the relying party (if one exists in the metadata extensions). The URL scheme is limited to","type":"text"},{"text":" http:","type":"text","marks":[{"type":"code"}]},{"text":",","type":"text"},{"text":" https: ","type":"text","marks":[{"type":"code"}]},{"text":"and","type":"text"},{"text":" data:. O","type":"text","marks":[{"type":"code"}]},{"text":"ther types will not render but will result in an error message in the log.","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that the specification allows for a logo to provided with no language associated. If an logo for an appropriate language exists then this is returned, otherwise the no-language logo is returned (assuming that it fits the size constraints as detailed below).","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Two forms exist. The first four parameters are supplied these are (respectively) the minimum width, the minimum height, the maximum width and the maximum height (in pixels) that the logo can be. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The second form has no parameter and any logo which fits the language constraints is returned.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"#set ($logo=$rpUIContext.logo)\n#set ($serviceName=$rpuiContext.serviceName)\n#if ($logo) \n $\"$encoder.encodeForHTMLAttribute($serviceName)\"/$ \n#end","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"The logo is defined in the ","type":"text"},{"text":"SAML Metadata Login and Discover UI Extensions","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-metadata-ui/v1.0/cs01/sstc-saml-metadata-ui-v1.0-cs01.pdf"}}]},{"text":" specification.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"$rpUIContext.","type":"text"},{"text":"organizationDisplayName","type":"text"}]},{"type":"paragraph","content":[{"text":"This returns the (language specific) OrganizationDisplayName if it exists in the metadata for the relying party. ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"#set ($odn=$rpUIContext.organizationDisplayName)\n#if ($odn)\n $encoder.encodeForHTML($odn)\n#end","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"No parameter should be specified.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"The OrganizationDisplayName is defined in the ","type":"text"},{"text":"SAML Metadata","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf"}}]},{"text":" specification","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"$rpUIContext.","type":"text"},{"text":"organizationName","type":"text"}]},{"type":"paragraph","content":[{"text":"This returns the (language specific) OrganizationName if it exists in the metadata for the relying party. ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"#set ($on=$rpUIContext.organizationName)\n#if ($on)\n $encoder.encodeForHTML($on)\n#end","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"No parameter should be specified.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"The OrganizationName is defined in the ","type":"text"},{"text":"SAML Metadata","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf"}}]},{"text":" specification","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"$rpUIContext.","type":"text"},{"text":"organizationURL","type":"text"}]},{"type":"paragraph","content":[{"text":"This returns the (language specific) OrganizationURL URL if it exists in the metadata for the relying party. The URL scheme is limited to","type":"text"},{"text":" http:","type":"text","marks":[{"type":"code"}]},{"text":" and","type":"text","marks":[{"type":"code"}]},{"text":" https:. O","type":"text","marks":[{"type":"code"}]},{"text":"ther types will not render but will result in an error message in the log.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"#set ($ourl=$rpUIContext.organizationURL)\n#set ($odn=$rpUIContext.organizationDisplayName)\n#if ($ourl && $odn)\n $encoder.encodeForHTML($odn)\n#end","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"No parameter should be specified.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"The OrganizationURL is defined in the ","type":"text"},{"text":"SAML Metadata","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf"}}]},{"text":" specification","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"$rpUIContext.","type":"text"},{"text":"privacyStatementURL","type":"text"}]},{"type":"paragraph","content":[{"text":"This returns the (language specific) PrivacyStatementURL URL if it exists in the extensions of the metadata for the relying party. The URL scheme is limited to","type":"text"},{"text":" http: and","type":"text","marks":[{"type":"code"}]},{"text":" https:. O","type":"text","marks":[{"type":"code"}]},{"text":"ther types will not render but will result in an error message in the log.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"#set ($psurl=$rpUIContext.privacyStatementURL)\n#if ($psurl)\n Privacy Statement\n#end","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"No parameter should be specified.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"The PrivacyStatementURL is defined in the ","type":"text"},{"text":"SAML Metadata Login and Discover UI Extensions","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-metadata-ui/v1.0/cs01/sstc-saml-metadata-ui-v1.0-cs01.pdf"}}]},{"text":" specification.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"$rpUIContext.","type":"text"},{"text":"serviceDescription","type":"text"}]},{"type":"paragraph","content":[{"text":"This returns the (language specific) description of the service.","type":"text"}]},{"type":"paragraph","content":[{"text":"The description is located as follows:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For every possible language","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Search the metadata extensions for the relying party for a matching Description, return this is found","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Search the AttributeConsumingService for the request (which will be part of the metadata for the relying party) for a matching ServiceDescription, return this if found","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Otherwise return null","type":"text"}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"#set ($desc = $rpUIContext.getServiceDescription())\n#if ($desc)\n $encoder.encodeForHTML($desc)\n#end","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"No parameter should be specified.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"The Description is defined in the ","type":"text"},{"text":"SAML Metadata Login and Discover UI Extensions","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-metadata-ui/v1.0/cs01/sstc-saml-metadata-ui-v1.0-cs01.pdf"}}]},{"text":" specification.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ServiceDescription is defined in the ","type":"text"},{"text":"SAML Metadata","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf"}}]},{"text":" specification","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"$rpUIContext.","type":"text"},{"text":"serviceName","type":"text"}]},{"type":"paragraph","content":[{"text":"This will always return a value. As for the serviceDescription, the search is compound through both the metadata and the metadata extensions","type":"text"}]},{"type":"paragraph","content":[{"text":"The Service Name is located as follows:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For every possible language","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Search the metadata extensions for the relying party for a matching DisplayName, return this is found","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Search the AttributeConsumingService for the request (which will be part of the metadata for the relying party) for a matching ServiceName, return this if found","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Otherwise return a name derived from the EntityID of the relying party","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the EntityID is a URI (which it should be) and has a schema of","type":"text"},{"text":" http:","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"https: ","type":"text","marks":[{"type":"code"}]},{"text":"return the hostname from the URI.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Otherwise return the entityID in full","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"For example, absent appropriate metadata ","type":"text"},{"text":"https://sp.example.org/shibboleth","type":"text","marks":[{"type":"code"}]},{"text":" would return ","type":"text"},{"text":"sp.example.org,","type":"text","marks":[{"type":"code"}]},{"text":" whilst ","type":"text"},{"text":"urn:mace:edu.internet:provider:identity:uni.edu","type":"text","marks":[{"type":"code"}]},{"text":" would be unchanged.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"#set ($rpContext = $profileRequestContext.getSubcontext('net.shibboleth.idp.profile.context.RelyingPartyContext'))\n#set ($serviceName = $rpUIContext.serviceName)\n// Do not diplay anything if there is no metadata support\n#if ($serviceName && !$rpContext.getRelyingPartyId().contains($serviceName))\n \n #springMessageText(\"idp.login.loginTo\", \"Login to\") $encoder.encodeForHTML($serviceName)\n \n#end","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"No parameter should be specified.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Specification","type":"text"}]},{"type":"paragraph","content":[{"text":"The DisplayName is defined in the ","type":"text"},{"text":"SAML Metadata Login and Discover UI Extensions","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-metadata-ui/v1.0/cs01/sstc-saml-metadata-ui-v1.0-cs01.pdf"}}]},{"text":" specification.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ServiceName is defined in the ","type":"text"},{"text":"SAML Metadata","type":"text","marks":[{"type":"link","attrs":{"href":"http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf"}}]},{"text":" specification","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported