/settings/set

Assign a key-value pair for a particular client_id. If the key does not exist, it will be created. If the key already exists, this call overwrites the existing value.

Returns a Boolean that indicates whether the key already existed. true indicates the key has been overwritten. false indicates that a new key has been created.

Note. You cannot use settings/set to modify the application-wide default settings. You must use settings/set_default for this purpose.

This endpoint includes the following methods:

  • POST

POST

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Janrain Capture domain; for example:

https://educationcenter.us-dev.janraincapture.com

Your Capture domains (also known as Registration domains) can be found in the Janrain Console on the Manage Application page:

Examples

Example Request

Assign the value Robert to the key owner for the client with the ID fghi7890fghi7890.


curl -X POST \
    -H "Authorization: Basic aW1fYV...NfbXk="\
    --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

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