Modify a Client Setting

Endpoint URL: {registrationDomain}/ settings/set

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.

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


Authorized Clients

  • owner login_client 
  • direct_read_access 
  • direct_access 
  • access_issuer

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

ParameterTypeRequiredDescription
keystringYesKey to add or modify.
 
valuestringYesValue assigned to the key being added or modified.
 
for_client_idstring
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"
}