Use the get-branded-idp operation to retrieve the branded IdP URL for a specific site.
A request XML packet retrieving the branded IdP URL for a specific site includes the get-branded-idp operation node:
<packet>
<sso>
<get-branded-idp>
...
</get-branded-idp>
</sso>
</packet>
The get-branded-idp node is presented by type SSOGetRelayInput (sso.xsd
), and its graphical representation is as follows:
sso.xsd
).
Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.
The get-branded-idp node of the output XML packet is presented by type SSOGetRelayOutput (sso.xsd
) and structured as follows:
common.xsd
).sso.xsd
).The graphical presentation of this node is as follows:
The packet that retrieves the branded IdP URL for site example.com looks as follows:
<packet>
<sso>
<get-branded-idp>
<filter>
<http-request-domain>example.com</http-request-domain>
</filter>
</get-branded-idp>
</sso>
</packet>
Response:
<packet>
<sso>
<get-branded-idp>
<result>
<status>ok</status>
<filter-id>example.com</filter-id>
<id>42</id>
<record>
<idp-url>aWRwLmV4YW1wbGUyLmNvbToxMTgw</idp-url>
<http-request-domain>example.com</http-request-domain>
</record>
</result>
</get-branded-idp>
</sso>
</packet>
The packet that retrieves the branded IdP URLs for sites example.com and example2.com looks as follows:
<packet>
<sso>
<get-branded-idp>
<filter>
<http-request-domain>example.com</http-request-domain>
<http-request-domain>example2.com</http-request-domain>
</filter>
</get-branded-idp>
</sso>
</packet>
Response:
<packet>
<sso>
<get-branded-idp>
<result>
<status>ok</status>
<filter-id>example.com</filter-id>
<id>42</id>
<record>
<idp-url>aWRwLmV4YW1wbGUyLmNvbToxMTgw</idp-url>
<http-request-domain>example.com</http-request-domain>
</record>
</result>
<result>
<status>ok</status>
<filter-id>example2.com</filter-id>
<id>43</id>
<record>
<idp-url>c3NvLmV4YW1wbGUyLmNvbQ==</idp-url>
<http-request-domain>example2.com</http-request-domain>
</record>
</result>
</get-branded-idp>
</sso>
</packet>