/settings/delete

Deletes a key from the settings for a particular client. Returns a Boolean indicating whether the key existed. This does not modify the application-wide default value for a key.

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

Delete the key owner for a particular client.


curl -X POST \
    -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode for_client_id=fghi7890fghi7890\
    --data-urlencode key=owner \
    https://my-app.janraincapture.com/settings/delete
  
      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 be deleted from the client settings. You can use the /settings/keys endpoint to return a list of available keys.
 
for_client_id string Client ID of the client whose key will be deleted. Only the application owner is authorized to send requests using this parameter.
 

Responses

200 OK

Response Example (application/json)


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