Endpoint URL: {registrationDomain} /settings/widget/get
Description
Returns the published settings for the specified API client; if the version parameter is not included, the most recent version of the published settings will be returned. See the settings/widget/publish endpoint for more information on published settings.
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-
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 the published settings for the API with the client ID fghi7890fghi7890 and the version ID a728bbcf-fb9f-4162-8204-794ac8ee7a8e.
curl -X POST \ -H "Authorization: Basicc2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \ --data-urlencode for_client_id=fghi7890fghi7890 \ --data-urlencode version=123abc45-de67-fgh8-9ijk-0lmn123op45q \ https://my-app.janraincapture.com/settings/widget/get
Running this command in Postman
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. |
Responses
200 OK
Response Example (application/json)
{
"results": {
"janrain_settings_version": "123abc45-de67-fgh8-9ijk-0lmn123op45q",
"minimum_age": "13"
},
"stat": "ok"
}
