Gigya Job Openings

fidm.saml.importIdPMetadata REST

Skip to end of metadata
Go to start of metadata

Description

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

Request URL


Where <Data_Center> is:
  • us1.gigya.com - For the US data center.
  • eu1.gigya.com - For the European data center.
  • au1.gigya.com - For the Australian data center.
  • ru1.gigya.com - For the Russian data center.
  • cn1.gigya-api.cn - For the Chinese data center.

If you are not sure of your site's data center, see Finding Your Data Center.

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 .
format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
context string/JSON This parameter may be used to pass data through the current method and return it, unchanged, within the response.
dontHandleScreenSet Boolean This parameter may be used in order to suppress the showing of screen-sets as a result of API calls. Default is false.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:

  • accounts.login
  • socialize.login
  • accounts.notifyLogin
  • socialize.notifyLogin
  • accounts.finalizeRegistration
  • accounts.linkAccounts

Please refer to the Authorization Parameters section for details. 

 

Response Data

FieldTypeDescription
configExternalIdP objectA SAML IdP configuration object built from the metadata.
 
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.

 

A field that does not contain data will not appear in the response.

 

Response Example

{
  "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"
}