/set_auth_providers

Use set_auth_providers to define the list of identity providers provided by the Janrain server to sign-in enabled pages. This is the same list that is managed by the dashboard.

This call modifies the list of providers presented to the user.

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([System.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

This method returns an empty success response if it completes without error.


curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234\
    --data-urlencode providers='["facebook","yahoo"]'\
    https://janrain-docs.rpxnow.com/api/v2/set_auth_providers
                           

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.
 
device_type string Without a parameter value, set_auth_providers affects the provider list for the web version of the Social Login UI.

Allowed parameter values are:
 
  • web  (changes the providers presented to normal web traffic)
  • iphone (changes the providers presented to web traffic identified as originating from an iPhone)
  • android (changes the providers presented to web traffic identified as originating from an android based mobile device)
providers string Yes A comma-separated string of provider specifiers. See Identity Providers.