/settings/set_multi

Assigns multiple settings for the specified API client. If any of the specified keys do not exist, then a new key by that name will be created. If any of the specified keys do exist, the current values of those keys will be overwritten by the new values supplied in the API call. Note that this endpoints only works against client-specific settings; application settings are ignored.

This endpoint includes the following methods:

POST

POST

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 values to three keys associated with the API client fghi7890fghi7890:

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 for_client_id=fghi7890fghi7890 \
  --data-urlencode items='{"owner":"Jay","public":"true","level":"10"}' \
  https://my-app.janraincapture.com/settings/set_multi

Running this command in Postman

Authorized Clients

owner
login_client
direct_read_access
direct_access
access_issuer

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.
for_client_id	string	Yes	Client ID for the client being assigned the key-value pairs. Only the application owner is authorized to send request using this parameter.

Responses

200 OK

Response Example (application/json)


{
  "result": {
    "owner": true,
    "public": 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.

POST

Running this Command in Postman

How to Create an Authentication String

Rate this Article