Delete Published Client Settings

Endpoint URL: {registrationDomain} /settings/widget/delete



Description

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


Respects the API Client Allow List: Yes


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 published settings for the API with the client ID fghi7890fghi7890 and the version ID a728bbcf-fb9f-4162-8204-794ac8ee7a8e:


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

      Running this command in Postman


Query Parameters

ParameterTypeRequiredDescription
for_client_idstringYesClient ID of the client whose settings will be deleted.
 
versionstring
Version number of the settings to be deleted.
 
commitboolean
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"
}