Administration

Remove Tenant

Remove the tenant. The system tenant _mm account cannot remove.

Note: Requires administrator permissions.

delete/_api/tenant/{tenant}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/tenant/:tenant/delete.ts
A function with typed inputs. Its response is checked against the schema.

tenantstring string required

The tenant name to remove. The main default system tenant _mm cannot remove.

Successfully removed tenant.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

resultboolean

True if tenant removed successfully.

{
  "code": 200,
  "result": true
}

No recorded changes to this operation across all 1 revision of this API.