Modify Multiple Application Settings

Endpoint URL: {registrationDomain} /settings/set_default_multi




Description

Assigns multiple keys for the application-wide default settings. If the key specified in your API call does no exist, the endpoint will create a new key using the default value. If the key does exist, the current value of the key will be overwritten. If your API call succeeds, you'll get back a Boolean value that indicates whether the key already existed. A true value means that the key has been overwritten; a false means a new key has been created.

Note. You cannot use settings/set_default_multi to modify any client-specific 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-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 makes the following key assignments for the application that uses the URL https://my-app.janraincapture.com:

  • The owner key is set to Jay  
  • The public key is set to true
  • The level key is set to 10

curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode items='{"owner":"Jay","public":"true","level":"10"}' \
  https://my-app.janraincapture.com/settings/set_default_multi
  

      Running this command in Postman


Query Parameters

ParameterTypeRequiredDescription
itemsstringYesJSON object containing the key-value pairs being assigned to the client.
 


Responses

200 OK

Response Example (application/json)


{
  "result": {
    "public": false,
    "owner": false,
    "level": false
  },
 "stat": "ok"
}