/settings/widget/delete

Deletes the published settings for the specified API client and version. If the version parameter is not included, all versions of the settings published for the API client will be deleted. See settings/widget/publish for more information on published settings.

This endpoint includes the following methods:

  • POST

POST

Authentication

This endpoint supports Basic authentication. To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it.

For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

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


curl -X POST \
    -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode for_client_id=fghi7890fghi7890\
    --data-urlencode version=123abc45-de67-fgh8-9ijk-0lmn123op45q \
    --data-urlencode commit=true\
    https://my-app.janraincapture.com/settings/widget/delete
  

Authorized Clients

  • owner

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

Parameter Type Required Description
for_client_id string Yes Client ID of the client whose settings will be deleted.
 
version string Version number of the settings to be deleted.
 
commit boolean Set to true in order to delete the settings. The default value is false.
 

Responses

200 OK

Response Example (application/json)


{
  "results": "The settings files were deleted",
  "stat": "ok"
}