/settings/set_default

Creates or updates a key in the application-wide default settings. If the key does not exist, a new key will be created. If the key does exist, the current value of that key will be overwritten.

Your API call will return a Boolean value that indicates whether the key already existed: true indicates that the key has been overwritten, while 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


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 default to the permissions key for the application that uses the URL https://my-app.janraincapture.com.


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

ParameterTypeRequiredDescription
keystringYesThe key being added or modified.
 
valuestringYesThe value being assigned to the key.
 

Responses

200 OK

Response Example (application/json)


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