/get_backplane_properties

Use this call for Backplane Protocol-enabled Janrain solutions only. 

The get_backplane_properties call queries the Backplane server to verify that Backplane credentials have been set up. If the proper credentials are in place, details are returned. If not, no details are returned.

Accepted Content-types

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

This endpoint includes the following methods:

  • POST


POST

Authentication

This endpoint support Basic authentication.

How to Create an Authentication String

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


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 Janrain Dashboard.