/settings/widget/publish

Publish API client settings to a JSON file available for client-side use with the Registration UI. This allows settings to be loaded prior to any server-side calls. Published client settings are typically used to support a configurable minimum age requirement for registration or tracking user acceptance of different terms of service and privacy policies on a per-site basis.

The settings to be published for an API client are configured in an additional setting called jump_publish_settings. In order for the Registration UI to load the JavaScript file where these settings are published, the hasSettings JavaScript setting must be set to true.

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 Janrain Capture domain; for example:

https://educationcenter.us-dev.janraincapture.com

Your Capture domains (also known as Registration domains) can be found in the Janrain Console on the Manage Application page:

Examples

Example Request


curl -X POST \
    -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode for_client_id=fghi7890fghi7890\
    --data-urlencode include_settings=true\
    https://my-app.janraincapture.com/settings/widget/publish"stat": "ok"
}
  

Running Code Samples Using Postman

The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:

  1. Click the Copy to Clipboard button located directly beneath the code sample
  2. In Postman, click Import to display the Import dialog box.
  3. In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:

  4. Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.

Authorized Clients

  • owner

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

Parameter Type Required Description
for_client_id string Yes Client ID of the client whose settings are to be published.
 
include_settings string If set to true, published settings are returned as part of the response.
 

Responses

200 OK

Response Example (application/json)


{
  "results": {
    "janrain_settings_version": "123abc45-de67-fgh8-9ijk-0lmn123op45q",
    "minimum_age": "13"
  },
  "stat": "ok"
}