Get SAML ID Provider Details

To view the details of a SAML identity provider, use the following request:

GET /settings/authentication/saml_id_providers/:id.xml
GET /settings/authentication/saml_id_providers/:id.json

XML Request Example

curl -s -k -i -X GET -u 'user:userpass' --url https://onapp.test/settings/authentication/saml_id_providers/3.xml

JSON Request Example

curl -s -k -i -X GET -u 'user:userpass' --url https://onapp.test/settings/authentication/saml_id_providers/3.json

XML Output Example

<saml_id_provider>
  <id type="integer">2</id>
  <name>provider_name</name>
  <issuer>https://service.provider.com</issuer>
  <icon></icon>
  <idp_sso_target_url>https://onapp.com/ls</idp_sso_target_url>
  <idp_cert>-----BEGIN CERTIFICATE----- MIIDojCCAooCCQCrsOX18n/ZrTANBgkqhkiG9w0BAQsFADCBkjELMAkGA1UEBhMC VUExDTALBgNVBAgMBEx2aXYxDTALBgNVBAcMBEx2aXYxDjAMBgNVBAoMBU9uQXBw                        MQwwCgYDVQQLDANJbnYxGzAZBgNVBAMMEmFkZnMub25hcHBkZXYubHZpdjEqMCgG CSqGSIb3DQEJARYbb2xla3NhbmRyLmFudG9ub3ZAb25hcHAuY29tMB4XDTE4MDUw NzA4MDQxOVoXDTIzMDUwNjA4MDQxOVowgZIxCzAJBgNVBAYTAlVBMQ0wCwYDVQQI DARMdml2MQ0wCwYDVQQHDARMdml2MQ4wDAYDVQQKDAVPbkFwcDEMMAoGA1UECwwD SW52MRswGQYDVQQDDBJhZGZzLm9uYXBwZGV2Lmx2aXYxKjAoBgkqhkiG9w0BCQEW G29sZWtzYW5kci5hbnRvbm92QG9uYXBwLmNvbTCCASIwDQYJKoZIhvcNAQEBBQAD ggEPADCCAQoCggEBAMosVK5FKK2cblXTSYGpJQbgmcCYyhTQOfn/X6uC/85gDjAU RPtj++eOSkLU/fNrBoL5K2JzZDebRMxWWSkZF6C82GcqH+zqMDDL4AdQkTylWCla 6KsORmtlQqMknCVnTOeci9ICsIrWuB8pbSuwunW5/yzjZ8gohDE25+vihEY4wPQb j2/PRwlTJN0LfieDYhsr4J6y93UhLOHS9DtxD98PFhMD2OZLTPbxv7DXeU+C3M/F IHbLtf72+IJjXw6c1giBzYmLM39bdkn5CGZRfRaDOPABzcGy/+NM4XdlM3pOUkeF dfx/NbdbsqLi6MxJXKtC59k7TsFotNit5/AvpN8CAwEAATANBgkqhkiG9w0BAQsF AAOCAQEAmeHx1dquVw9zgLpJRDJxmoxDKaoPCHK3rzaD7YI/Pl3SRJa+60nuLvzH cXjkwDKZlAS0A6JSzHVq7LvA72Qz/f6XmV817iN5NuJZ1CFH9xRAVYosPhQJVTJa +QYNSiMgpgvHk5NVC3kvXxIdXY1RW/zN5hawPSMemvEGgkZKi/polEAMaRwXV851 iH9pi8s2wU+PI93a3qXIavpBTtRAN7maGEZAzwH27szCriE1+oU4XgUKN4bq9dGN ic3nB0zDz+s5lb0yRsQowcGpFmqOofsWWs54t2ItJnKdU/tcQp4zcpAMlLaGIQQX 1jpN8X6En2IXeYJgLuQJieH7oKOvpg== -----END CERTIFICATE----- </idp_cert>
  <enabled type="boolean">true</enabled>
  <onapp_key>OnApp_key</onapp_key>
  <user_name_key>un_key</user_name_key>
  <roles_key></roles_key>
  <user_group_key></user_group_key>
  <time_zone_key></time_zone_key>
  <created_at type="dateTime">2020-08-04T14:27:32+03:00</created_at>
  <updated_at type="dateTime">2020-08-04T14:27:32+03:00</updated_at>
  <nameid_format>emailAddress</nameid_format>
  <user_email_key>OnApp_UserEmail</user_email_key>
  <private_key></private_key>
  <user_billing_plan_key>bp_key</user_billing_plan_key>
  <first_name_key/>
  <last_name_key/>
  <locale_key/>
  <system_theme_key/>
  <display_infoboxes_key/>
  <disable_auto_suspend_key/>
  <suspend_after_key/>
  <suspend_at_key/>
  <idp_slo_target_url>https://onapp.com/ls/?wa=wsignoutcleanup1.0</idp_slo_target_url>
  <certificate>-----BEGIN CERTIFICATE----- MIIDojCCAooCCQCwhOE0P+RTMTANBgkqhkiG9w0BAQsFADCBkjELMAkGA1UEBhMC VUExDTALBgNVBAgMBEx2aXYxDTALBgNVBAcMBEx2aXYxDjAMBgNVBAoMBU9uQXBw MQwwCgYDVQQLDANJbnYxGzAZBgNVBAMMEmFkZnMub25hcHBkZXYubHZpdjEqMCgG CSqGSIb3DQEJARYbb2xla3NhbmRyLmFudG9ub3ZAb25hcHAuY29tMB4XDTE4MDUw NzA4MDg0M1oXDTIzMDUwNjA4MDg0M1owgZIxCzAJBgNVBAYTAlVBMQ0wCwYDVQQI DARMdml2MQ0wCwYDVQQHDARMdml2MQ4wDAYDVQQKDAVPbkFwcDEMMAoGA1UECwwD SW52MRswGQYDVQQDDBJhZGZzLm9uYXBwZGV2Lmx2aXYxKjAoBgkqhkiG9w0BCQEW G29sZWtzYW5kci5hbnRvbm92QG9uYXBwLmNvbTCCASIwDQYJKoZIhvcNAQEBBQAD ggEPADCCAQoCggEBAJ/TptRcuX+kIy8bvpkInyTsb+vzYW0I/M3kIFznAK1TEJy1 gVYLgU9y1Ai1K7raoOmfDXKr7K/cHsPFBnv/hdCEOj3SsdzNQ4v8BlT+43wbw0u3 w5+4vfg2lKUl8ifx0qvvlPcMUY8Bt8q8M88qNuoam3xfHqx8cIdZ45MjzWjpkr8r MxwH67YRCqk6TqDINjvhfG7lDge491vtn7XMWqD0+JBzaeQcJ2QYiMRFM2u44O28 jPSYb2hdaVKe6nmi0n7mgL21a0FWppNQLVRCQYiK9S0xtddzuJR9DtsxYTux3I6y G0UhXlqNF869eyR8F4BzBHPAuqP9JZ2Jg/tyigkCAwEAATANBgkqhkiG9w0BAQsF AAOCAQEAj1PMFN7m4Rj6VfXstnWqpxhAOse8pYmelUIU5iVughOltVWPK3tj1oXc GZ7nbIRxpb6PJRvJEG5YgOMEsqKbNHILWPndwmc3BtEBK2GBPPZspJSx9QCkHeNw NmVFS4DNjiddJey1h+Cjqf8tiXxPJ2JXyurBQkhuWKky3GKv3TiY5LM5v/YYIHUw iH4jNJyomCtDFSL3M2FTqCPj/oWho76/IPfhblTVYJGDA0wqB6vstPUibc6PMkO+ b+KMRKpor1phiIvdAZueScwxJ1X/1+q2ACiTPbaNPE67f9O0OIrK6I8qFXbLfUoC gHzxSXwSyfclkPs92UVPI3ufQOIMKQ== -----END CERTIFICATE----- </certificate>
  <show_on_login_page type="boolean">true</show_on_login_page>
</saml_id_provider>

Where: 

id – the ID of the identity provider 

name – the name of the identity provider 

issuer – the name of the service provider

icon – the icon that is displayed on the login page

idp_sso_target_url – the URL to which the login authentication request is sent

idp_cert – the certificate of the identity provider in PEM format

enabled – the status of the identity provider that can be enabled if true or disabled if false 

onapp_key  the key of the attribute that enables the import and synchronization of user attributes during every login to OnApp through the IdP instance

user_name_keythe key that assigns the user to a particular user login

roles_key – the key of the role attribute that creates or syncs the user's role in OnApp

user_group_key – the key of the attribute that assigns the user to a particular user group

time_zone_key  the key of the attribute that assigns the user to a particular time zone 

created_at  the date when the identity provider was created

updated_at – the date when the identity provider was updated

nameid_format  the name identifier format according to the Oasis SAML specification

user_email_key – the key of the attribute that provides an email of the user

private_key – the private key for the enabled encrypted assertion

user_billing_plan_key – the key of the attribute that assigns the user to a particular bucket under which this user is billed

first_name_key – the key of the attribute that imports the first name of the user

last_name_key  the key of the attribute that imports the last name of the user

locale_key – the key of the attribute that contains the language in which OnApp Cloud UI is available to the user

system_theme_key  the key of the attribute that indicates a default system theme in which OnApp Cloud UI is available to the user

display_infoboxes_key  the key of the attribute that enables or disables the display of infoboxes to the user

disable_auto_suspend_key – the key of the attribute that enables or disables the auto-suspending of the user

suspend_after_key  the key of the attribute that indicates the period of time in hours after which the user will be suspended

suspend_at_key – the key of the attribute that indicates the date and time when the user will be suspended

idp_slo_target_url – the URL to which the logout request is sent

certificate - the certificate of the service provider in PEM format

(lightbulb)show_on_login_page - true if the option to show a SAML provider on the login page is enabled, otherwise false


Page History

v.6.6 Edge 3

  • added the show_on_login_page parameter