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.
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-
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
Running this command in Postmancurl -X POST \ -H "Authorization: Basic
c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \ --data-urlencode items='{"owner":"Jay","public":"true","level":"10"}' \ https://my-app.janraincapture.com/settings/set_default_multi
Authorized Clients
- owner
Security
- janrain-signed
- basic-auth
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
items | string | Yes | JSON 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"
}