View Multiple Client Settings

Endpoint URL: {registrationDomain} /settings/get_multi




Description

Returns value for multiple keys. By design, values are returned for keys configured at the client scope. If a key does not exist at the client scope, then the value of the key as configured at the application scope is returned instead.


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 the values assigned to the owner, level, and public keys for the API client fghi7890fghi7890.

curl -X POST \
    -H "Authorization: Basic dXQ0YmdycmE3dzI4MmpjZm15cGZxeDlwemhxaGpqMmI6dW5qemU5bndrZnV5NmpwdzgzOHFwYTdhZDNoZG55YTY=" \
    --data-urlencode for_client_id=m7cvpvw4skxb629wahqag8qeks2t6mfe \
    --data-urlencode keys='["owner","public","level"]' \
    https://greg-stemp.us-dev.janraincapture.com/settings/get_multi

      Running this command in Postman


Query Parameters

ParameterTypeRequiredDescription
keysstringYesJSON array of the keys to be retrieved.
 
for_client_idstringYesClient ID of the client whose keys are being retrieved. Only the application owner is authorized to send requests using this parameter.
 


Responses

200 OK

Response Example (application/json)


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