Soft delete a Tenant
DELETE/tenants/:id
Soft delete a Tenant
Request
Path Parameters
ID of the Tenant
.
Responses
- 200
- 304
- 400
- 404
Deleted Tenant details, with a non-empty deleted_at
field
- application/json
- Schema
- Example (from schema)
Schema
The tenant name. It should match the pattern ^[a-z-]+$
.
The SDP backend server's base URL.
The SDP UI/dashboard Base URL.
Possible values: [TENANT_CREATED
, TENANT_PROVISIONED
, TENANT_ACTIVATED
, TENANT_DEACTIVATED
]
The Stellar account address used for distributing funds.
Possible values: [ENV_STELLAR
, DB_VAULT_STELLAR
]
The Stellar account type used for distributing funds.
Possible values: [ACTIVE
, PENDING_USER_ACTIVATION
]
The status of the distribution account used for distributing funds.
Boolean flag that shows whether the tenant is the default or not.
The timestamp when the tenant was (soft) deleted.
{
"id": "840dca45-d1df-44cd-83c1-65c04235c25f",
"name": "redcorp",
"base_url": "https://redcorp-backend.sdp.org",
"sdp_ui_base_url": "https://redcorp.sdp.org",
"status": "TENANT_PROVISIONED",
"distribution_account": "GCQVDMPOEN3HHJJ64V42KUTONOXN7C6V2PSVPALEVJ7PIYOB6M3DJV7N",
"is_default": true,
"created_at": "2024-03-27T17:21:51.000Z",
"updated_at": "2024-03-27T17:21:51.000Z"
}
The tenant was already deleted before this request.
- application/json
- Schema
- Example (from schema)
Schema
The tenant name. It should match the pattern ^[a-z-]+$
.
The SDP backend server's base URL.
The SDP UI/dashboard Base URL.
Possible values: [TENANT_CREATED
, TENANT_PROVISIONED
, TENANT_ACTIVATED
, TENANT_DEACTIVATED
]
The Stellar account address used for distributing funds.
Possible values: [ENV_STELLAR
, DB_VAULT_STELLAR
]
The Stellar account type used for distributing funds.
Possible values: [ACTIVE
, PENDING_USER_ACTIVATION
]
The status of the distribution account used for distributing funds.
Boolean flag that shows whether the tenant is the default or not.
The timestamp when the tenant was (soft) deleted.
{
"id": "840dca45-d1df-44cd-83c1-65c04235c25f",
"name": "redcorp",
"base_url": "https://redcorp-backend.sdp.org",
"sdp_ui_base_url": "https://redcorp.sdp.org",
"status": "TENANT_PROVISIONED",
"distribution_account": "GCQVDMPOEN3HHJJ64V42KUTONOXN7C6V2PSVPALEVJ7PIYOB6M3DJV7N",
"is_default": true,
"created_at": "2024-03-27T17:21:51.000Z",
"updated_at": "2024-03-27T17:21:51.000Z"
}
Bad request, when the tenant is not elligible to be deleted. For example, when the tenant is the default tenant or when it has not been patched with the deactivated status.
- application/json
- Schema
Schema
- any
Not Found
Response Headers
- application/json
- Schema
- Example (from schema)
- response
Schema
extras object
{
"error": "string",
"extras": {
"status": 0,
"message": "string"
}
}
{
"error": "Not found",
"extras": {
"status": 404,
"message": "Resource not found"
}
}