Modify a Client Setting

Endpoint URL: {registrationDomain}/ settings/set

Description

Assigns a key-value pair for to an API client. If the specified key does not exist, it will be created. If the key does exists, then the current value of that key will be overwritten.

Your API call will return a Boolean value that tells you whether the key already existed: true indicates the key has been overwritten, while false indicates that a new key has been created.

Note. You cannot use settings/set to modify the application-wide default settings. Instead, use the settings/set_default endpoint to modify application 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 assigns the value Robert to the owner key for API client fghi7890fghi7890.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode for_client_id=fghi7890fghi7890 \
  --data-urlencode key=owner \
  --data-urlencode value=Robert \
  https://my-app.janraincapture.com/settings/set

Running this command in Postman

Query Parameters

Parameter	Type	Required	Description
key	string	Yes	Key to add or modify.
value	string	Yes	Value assigned to the key being added or modified.
for_client_id	string		Client ID of the client whose settings are being modified. Note that only the application owner is authorized to send requests using this parameter.

Responses

200 OK

Response Example (application/json)


{
  "result": 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

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