/settings/set_default

Set a key in the application-wide default settings. This will create a new key with a default value if the key does not yet exist in the application. If the key does exist, the value will be overwritten.

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

Note. You cannot use settings/set_default to modify any client-specific settings.

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 default to the key permissions.


curl -X POST \
    -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode key=permissions \
    --data-urlencode value=default \
    https://my-app.janraincapture.com/settings/set_default
  
      Running this command in Postman

Authorized Clients

  • owner

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

Parameter Type Required Description
key string Yes The key being added or modified.
 
value string Yes The value being assigned to the key.
 

Responses

200 OK

Response Example (application/json)


{
  "result": false,
  "stat": "ok"
}