Delete Tenant Settings
Use the Delete Tenant Settings API to delete the realm settings in a particular realm.
Resource Informations
| Name | Value |
|---|---|
| Requires authentication? | Yes |
| Rate limited? | No |
Request
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer token |
| Content-Type | application/json |
HTTP request URL for SSMS
DELETE https://{tenantId}.{hostname}/digitanium/v4/tenants/settings?key={demo}
HTTP request URL for SHIFT
DELETE https://{hostname}/auth/realms/{tenantId}/v3_realm/settings?key={demo}
note
API requests must be made over https. Calls made over plain http will fail.
Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Key | string | provide the settings name which needs to be deleted |
Request body
No request body fields are required.
Response
| Field Name | Type | Description |
|---|---|---|
| message | String | Message explains result of the API call. Refer Response status Information for details. |
| status | String | The status of the API call. Refer Response status Information for details. |
| subSystem | Integer | subSystem categorizes the type of API that has been called. Refer Subsystem details for details. |
Sample Response
{
"message": "Tenant setting deleted",
"status": "Success",
"subSystem": 1
}
Response Status Information
| Status Code | Status | Message |
|---|---|---|
| 200 | OK | Tenant setting deleted |
| 400 | BAD_REQUEST | Tenant setting(s) not found |
| 401 | Unauthorized | HTTP 401 Unauthorized |