/settings/delete

Deletes a key from the client settings for an API client. Note that this endpoint does not delete or modify any values configured at the application scope.

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 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 owner key associated with the API client with the ID fghij7890fghij7890.


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