Endpoint URL: {registrationDomain} /settings/set_multi
Description
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.
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-
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: Basicc2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \ --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
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"
}
