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 -i -X GET -u user:password --url https://onapp.test/settings/authentication/saml_id_providers/:id.xml

JSON Request example:

curl -i -X GET -u user:password --url https://onapp.test/settings/authentication/saml_id_providers/:id.json

XML Output example:

<?xml version="1.0" encoding="UTF-8"?>
  <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-----
	  MIIC4DCCAcigAwIBAgIQRRWNzx0Is7VMNYJ3u6vr+TANBgkqhkiG9w0BAQsFADAs
	  MSowKAYDVQQDEyFBREZTIFNpZ25pbmcgLSBhZGZzLm9uYXBwZGV2Lmx2aXYwHhcN
	  -----END CERTIFICATE-----
	</idp_cert>
    <enabled type="boolean">true</enabled>
    <assertion_consumer_service_url>https://test.onapp/users/auth/saml/callback?provider_id=1</assertion_consumer_service_url>
    <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">2017-09-19T15:59:56+03:00</created_at>
    <updated_at type="dateTime">2017-09-20T12:39:17+03:00</updated_at>
    <nameid_format>emailAddress</nameid_format>
    <user_email_key>OnApp_UserEmail</user_email_key>
    <encrypted_assertion type="boolean">false</encrypted_assertion>
	<private_key></private_key>
    <user_billing_plan_key>bp_key</user_billing_plan_key>
    <first_name_key></first_name_key>
    <last_name_key></last_name_key>
    <locale_key></locale_key>
    <system_theme_key></system_theme_key>
    <display_infoboxes_key></display_infoboxes_key>
    <disable_auto_suspend_key></disable_auto_suspend_key>
    <suspend_after_key></suspend_after_key>
    <suspend_at_key></suspend_at_key>
    <idp_slo_target_url>https://onapp.com/ls/?wa=wsignoutcleanup1.0</idp_slo_target_url>
  </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 the PEM format

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

assertion_consumer_service_url – the URL of the assertion consumer service 

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

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

encrypted_assertion – the status of the encrypted assertion that can be enabled if true or disabled if false

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


Page History

v.6.0

Removed the idp_cert_fingerprint parameter.