Get SAML Service Provider Metadata - GET /SamlServiceProvider/metadata (v2.0 and up)

Get metadata (xml) for the SAML service provider.

Usage:

GET /SamlServiceProvider/metadata and get metadata for the SAML service provider

URL

/cxrestapi/auth/SamlServiceProvider/metadata

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>
Accept: application/json;v=1.0

Parameters

None

Success Response:

Code: 200 Success

Error Response:

Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

<md:EntityDescriptor entityID="http://localhost" ID="_59280630-ea4b-4dfe-bd46-5b253e729d6d" xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata">
<md:SPSSODescriptor ID="_3703498e-2aac-42d4-bc39-c10c76ae0dbe" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol" WantAssertionsSigned="true">
<md:KeyDescriptor>
<KeyInfo xmlns="http://www.w3.org/2000/09/xmldsig#">
<X509Data>
<X509Certificate>MIIDPzCCAiegAwIBAgIIdeTLjQSFpkgwDQYJKoZIhvcNAQENBQAwGTEXMBUGA1UEAwwOQWNjZXNzIENvbnRyb2wwHhcNMTkwMjIwMDk0NDM3WhcNMjkwMjIwMDk0NDM3WjAZMRcwFQYDVQQDDA5BY2Nlc3MgQ29udHJvbDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAIxUCW1lFd598hJdHhBuUGOjMokZT3zOfepKqL8tjSu7nG5ImQrRbBcDfToQoL5X9Ey08EOhq6hVp6TJOoL9ggN8oqMCiIGqeg+Djcz293t/sFOtxfXsMc+……………………….. ==</X509Certificate>
</X509Data>
</KeyInfo>
</md:KeyDescriptor>
<md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="http://localhost/CxRestAPI/auth/identity/samlAcs" index="0" isDefault="true" />
<md:AttributeConsumingService index="0" isDefault="true">
<md:ServiceName xml:lang="en">auth</md:ServiceName>
<md:RequestedAttribute Name="First_Name" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" FriendlyName="First Name" isRequired="true" />
<md:RequestedAttribute Name="Last_Name" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" FriendlyName="Last Name" isRequired="true" />
<md:RequestedAttribute Name="Email" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" FriendlyName="Email" isRequired="true" />
<md:RequestedAttribute Name="Job" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" FriendlyName="Job Title" isRequired="false" />
<md:RequestedAttribute Name="Phone" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" FriendlyName="Phone Number" isRequired="false" />
<md:RequestedAttribute Name="Cell_Phone" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" FriendlyName="Cellular Phone Number" isRequired="false" />
<md:RequestedAttribute Name="Language" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" FriendlyName="Language Culture Name" isRequired="false">
<saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion">es-ES</saml:AttributeValue>
</md:RequestedAttribute>
<md:RequestedAttribute Name="Team" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" FriendlyName="Team Full Path" isRequired="false">
<saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion">CxServer/Team1/Team2/Team3</saml:AttributeValue>
</md:RequestedAttribute>
<md:RequestedAttribute Name="Role" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" FriendlyName="User Role Name" isRequired="false">
<saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion">Admin</saml:AttributeValue>
</md:RequestedAttribute>
</md:AttributeConsumingService>
</md:SPSSODescriptor>
</md:EntityDescriptor>

Notes:

Returns xml metadata for the SAML service provider.

Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to us. We appreciate your feedback!