/set_app_settings

Enables you to make API calls to set the following application properties (from the application settings page of the dashboard).

  • privacy policy — This URL is sent with requests for registration data and is displayed by the identity provider as a link to the user.
  • favicon — The URL of your favicon, which can be displayed by some identity providers during authentication.
  • domain redirect — This feature is only available for enterprise level apps and apps owned by Janrain's partners. A URL redirect destination for users visiting your sign-in url (such as, http://janrain-docs.rpxnow.com).
  • post tokens to token_url — Use the POST method of HTTP requests to submit auth_info tokens to your token URL.
  • one-time use auth_info tokens — Tokens for the auth_info API call can be used only once.
  • google profile url — Return users' globally unique Google profile URLs as the identifier element in the auth_info API call response instead of the OpenID URL.

Separate settings in the set_app_settings call with an ampersand (&). So the query:

privacyPolicy=https%3A%2F%2Fjanrain-docs.rpxnow.com%2Fprivacy&favicon=http%3A%2F%2Fjanrain-docs.rpxnow.com%2Ffavicon.ico&googleProfileUrl=true

sets privacyPolicy, favicon, and googleProfileUrl.

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


curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234\
    --data-urlencode privacyPolicy=https://janrain-docs.rpxnow.com/privacy\
    --data-urlencode favicon=http://janrain-docs.rpxnow.com/favicon.ico \
    --data-urlencode googleProfileUrl=true\
    https://janrain-docs.rpxnow.com/api/v2/get_app_settings
                               

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.
 
domainRedirect string URL where users are who access your sign-in URL redirected.
 
favicon string URL of your favicon. Favicons are icons that appear on web browser tabs, in a browser's address bar, and next to browser bookmarks.
 
googleProfileUrl string When set to true, Google Profile URls are returned instead of OpenID Connect URLs. The default value is false.
 
oneTimeUseTokens string When set to true, tokens cn only be used once before they expire.
 
postToTokenUrl string When set to true, uses the POST method to submit authentication tokens to your token endpoint.
 
privacyPolicy string URL to the location of your privacy policy.