Delete App
Delete App is used to delete an app, which has already been created using Create App.
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/apps/{appname}
OR
DELETE https://{tenantId}.{hostname}/digitanium/v4/app/remove?appname={appname}
HTTP request URL for SHIFT
DELETE https://{hostname}/auth/realms/{tenantId}/v3_client/{appname}
note
API requests must be made over https. Calls made over plain http will fail.
Parameters
Parameter Name | Type | Description |
---|---|---|
appname | String | Unique appName of the application. |
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. |
info
Request | Previous Behaviour | Expected and Current Behaviour |
---|---|---|
Hit the Delete client API and try to delete a client with a service account | The client will be deleted but the service account will not be deleted | On deleting the client, the service account is also deleted |
Sample Response
{
"message": "App delete successfully",
"status": "OK",
"subSystem": 2
}
Response Status Information
Status Code | Status | Message |
---|---|---|
200 | OK | App delete successfully |
401 | Unauthorized | HTTP 401 Unauthorized |
404 | APP_NOT_FOUND_STATUS | App does not exist |