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

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"
}

How to Create an Authentication String

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it. For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Before you actually try your authentication string, make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

Endpoint URL: {registrationDomain} /settings/set_default_multi

Description

API Client Permissions

Authentication

Base URL

Examples

Query Parameters

Responses

Running this Command in Postman

How to Create an Authentication String

Rate this Article