The set_backplane_properties call configures the Backplane server used to communicate with all of the Backplane-enabled apps on a page.
Accepted Content-types
- application/x-www-form-urlencoded
- multipart/form-data
This endpoint includes the following methods:
- POST
POST
Authentication
This endpoint supports Basic authentication. To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:
abcdefg:hijklmnop
Next, take the string and base64 encode it.
For example, on a Mac, you can base encode the string using this command:
echo -n "abcdefg:hijklmnop" | base64
If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:
[Convert]::ToBase64String([Sys tem.Text.Encoding]::UTF8. GetBytes("abcdefg:hijklmn"))
The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.
If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.
Make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.
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\
--data-urlencode server=example.com \
--data-urlencode bus=example_bus \
--data-urlencode username=larrydrebes \
--data-urlencode password=rosebud \
https://janrain-docs.rpxnow.com/api/v2/set_backplane_properties
Running this command in Postman
Example Response
{
"stat": "ok"
}
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
apiKey | string | Yes | Social Login API key. This key can be found on the Janrain Dashboard. |
bus | string | Yes | Backplane bus name. |
password | string | Password portion of the Backplane credentials. This parameter is required if you do not include the remove parameter. |
|
remove | string | When set to true, removes the Backplane configuration for the specified server or bus. When false, creates a new Backplane configuration. |
|
server | string | Yes | Domain name for the Backplane server. For example:documentation.janrain.com |
username | string | Username portion of the Backplane credentials. This parameter is required if you do not include the remove parameter. |
|
version | string | Backplane server version. The default value is v1. |