/settings/items

Returns all the settings for the specified API client, including all settings configured at the application scope: if a key is defined in both the client and application settings, only the client-specific value is returned. 

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 all the setting values (include application-wide settings) associated with the API client fghi7890fghi7890.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode for_client_id=fghi7890fghi7890 \
  https://my-app.janraincapture.com/settings/items
  
      Running this command in Postman

Authorized Clients

  • owner 
  • login_client 
  • direct_read_access 
  • direct_access 
  • access_issuer

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

Parameter Type Required Description
for_client_id string Client ID of the client whose settings are being retrieved. Note that only the application owner is authorized to send requests using this parameter.
 

Responses

200 OK

Response Example (application/json)


{
  "result": {
    "owner": "Jay",
    "public": "true",
    "level": "10"
  },
  "stat": "ok"
}