/settings/delete_default

Deletes a key from the application-wide default settings. This endpoint does not delete or modify any per-client 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 deletes the value currently assigned to the owner key. Note that this API call only removes the value assigned to the owner key; it does not delete the key itself.


curl -X POST \
    -H "Authorization: Basic dXQ0YmdycmE3dzI4MmpjZm15cGZxeDlwemhxaGpqMmI6dW5qemU5bndrZnV5NmpwdzgzOHFwYTdhZDNoZG55YTY=" \
    --data-urlencode key=owner \
   https://my-app.janraincapture.com/settings/delete_default
  

     Running this command in Postman


Authorized Clients

  • owner

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

ParameterTypeRequiredDescription
keystringYesKey to be deleted from the application settings. You can use the /settings/keys endpoint to return a list of available keys.
 

Responses

200 OK

Response Example (application/json)


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