View Published Settings for an Application

Endpoint URL: {registrationDomain} /settings/widget/list

Description

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.


Respects the API Client Allow List: Yes


API Client Permissions

The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:

owner
access_issuer
direct_access
direct_read_access
login_client
Yes
No
No
No
No


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


Query Parameters

ParameterTypeRequiredDescription
for_client_idstringYesClient ID of the client whose settings are being returned.
 
versionstring
Version number of the settings to be returned.
 


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"
}