/settings/widget/list

Returns a list of published settings files for the application. At least three files will be returned: a .JSON file for each settings version, and a .JSON file and .JS file where the most recently-published version is hosted for use by the Registration UI. Those three files will have filenames based on the following patterns:

/widget_data/settings/<appID>/<clientID>.json
/widget_data/settings/<appID>/<clientID>.js
/widget_data/settings/<appID>/<clientID>/<version>.json

If no parameters are included, all published settings files associated with the application will be listed. All parameters are optional, but if a version is specified the for_client_id parameter must also be included. See the settings/widget/publish endpoint for more information on published settings.

This endpoint includes the following methods:

POST

POST

Authentication

This endpoint supports Basic authentication.

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Identity Cloud Capture domain; for example:

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

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

Examples

Example Request

This command returns information about all the published setting files for the API with the client ID fghi7890fghi7890.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode for_client_id=fghi7890fghi7890 \
  https://my-app.janraincapture.com/settings/widget/list

Running this command in Postman

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 being returned.
version	string		Version number of the settings to be returned.

for_client_id string

The client identifier whose published settings files will be listed.

version string

The specific version of the published settings files that will be listed.

Responses

200 OK

Response Example (application/json)


{
  "results": [
    "widget_data/settings/789mdu24alp501skrbxz36dw08/12345abcde12345abcde12345abcde12.js",
    "widget_data/settings/789mdu24alp501skrbxz36dw08/12345abcde12345abcde12345abcde12.json",
    "widget_data/settings/789mdu24alp501skrbxz36dw08/12345abcde12345abcde12345abcde12/123abc45-de67-fgh8-9ijk-0lmn123op45q.json",
    "widget_data/settings/789mdu24alp501skrbxz36dw08/12345abcde12345abcde12345abcde12/67890def-6789-defg-6789-67890defgh67.json"
  ],
  "stat": "ok"
}

How to Create an Authentication String

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.

Before you actually try your authentication string, 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.

POST

Running this Command in Postman

How to Create an Authentication String