<style>
	.temporarily_disabled {
		display: none;
	}
</style>

This API imports a SAML Identity Provider (IdP) configuration from a SAML metadata XML.

Description

This API  imports a SAML Identity Provider (IdP) configuration from a SAML metadata XML.

Parameters

RequiredNameTypeDescription
metadatastring

A SAML metadata XML to import.

*Use either this parameter or the url parameter.

urlURL

A URL from which to fetch the metadata XML. If the URL is provided, the metadata XML is retrieved from it.

*Use either this parameter or the  metadata   parameter.

saveConfigurationBooleanThis parameter specifies whether to save the imported configuration.  
If false is provided, the system returns the metadata, but will not save it. 
The default value is false.
namestringThe name of the configuration to import. This parameter is required if saveConfiguration is set to true. The name will be used as part of the Social Network ID: "saml-", e.g., saml-name .

 

FieldTypeDescription
configExternalIdP objectA SAML IdP configuration object built from the metadata.

 

{
  "config": {
    "name": "https://idp.testshib.org/idp/shibboleth",
    "entityID": "https://idp.testshib.org/idp/shibboleth",
    "nameIDFormat": "urn:mace:shibboleth:1.0:nameIdentifier",
    "singleSignOnServiceUrl": "https://idp.testshib.org/idp/profile/SAML2/POST/SSO",
    "singleSignOnServiceBinding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST",
    "signAuthnRequest": false,
    "requireSAMLResponseSigned": true,
    "requireAssertionSigned": false,
    "requireAssertionEncrypted": false
  },
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK",
  "callId": "811ee6f788944d7da5c72ba4138ebc14",
  "time": "2015-03-22T11:42:25.943Z"
}