Delete a Client Setting

Endpoint URL: {registrationDomain} /settings/delete

Description

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.

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 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 <span class="fr-marker" data-id="0" data-type="true" style="display: none; line-height: 0;"></span><span class="fr-marker" data-id="0" data-type="false" style="display: none; line-height: 0;"></spa

Query Parameters

Parameter		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"
}

How to Create an Authentication String

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.

Before you actually try your authentication string, 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.

Endpoint URL: {registrationDomain} /settings/delete

Description

Respects the API Client Allow List: Yes

API Client Permissions

Authentication

Base URL

Examples

Query Parameters

Responses

Running this Command in Postman

How to Create an Authentication String

Rate this Article