/get_backplane_properties

Use this call for Backplane Protocol-enabled Identity Cloud solutions only. 

Queries the Backplane server to verify that Backplane credentials have been configured; as the name implies, this endpoint is only for use with Backplane protocol-enabled solutions. The Identity Cloud continues to support existing Backplane solutions, but new Backplane implementations are not available 

This endpoint includes the following methods:

  • POST


POST

Authentication

This endpoint uses your social login API key for authentication. This key can be found on the Settings page of the Social Login Dashboard.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

Base URL

The base URL for this endpoint is your application domain followed by /api/v2; for example:

https://educationcenter.rpxnow.com/api/v2

You can find your application domain in the Social Login (Engage Dashboard) on the Settings page:

Example Request

This command returns information about the Backplane protocol as configured for the social login application 
1234567891234567891234567891234567891234.


curl -X POST \
  --data-urlencode apiKey=1234567891234567891234567891234567891234 \
  https://janrain-docs.rpxnow.com/api/v2/get_backplane_properties 

      Running this command in Postman

Example Response


{
  "stat": "ok",
  "backplane_servers": []
}

Query Parameters

Parameter Type Required Description
apiKey string Yes Social Login API key. This key can be found on the Social Login Dashboard.