Suspend Tenant

This API suspends a specific tenant identified by its unique ID, setting its status to suspended.

Endpoint Details

URL	/v1/auth/tenants/id/suspend
Method	POST
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Request Path

To suspend a specific tenant, use the following request format:

/v1/auth/tenants/319a6060-fa5b-436b-95a5-77214d3d5c7d/suspend

---

Path Parameter

Parameter	Type	Description
id	UUID	Unique identifier of the tenant

---

Response

Here is an example response after the request has been successfully processed:

Response

{
    "tenant": {
        "id": "319a6060-fa5b-436b-95a5-77214d3d5c7d",
        "name": "dummy",
        "slug": "dummy",
        "status": "suspended",
        "owner_user_id": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "description": "contoh",
        "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "created_at": 1784187547,
        "updated_at": 1784187909
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the tenant
name	String	Name of the tenant
slug	String	Unique slug identifier of the tenant
status	String	Current status of the tenant
owner_user_id	UUID	Identifier of the user who owns the tenant
description	String	Description of the tenant
created_by	UUID	Identifier of the user who created the tenant
updated_by	UUID	Identifier of the user who last updated the tenant
created_at	Integer	Creation timestamp in Unix format
updated_at	Integer	Last update timestamp in Unix format

---

info

• A valid Bearer Token is required to access this endpoint.
• The id path parameter must reference an existing tenant.
• After a successful request, the tenant's status is set to suspended and its access is restricted until it is reactivated.
• Unix timestamp fields can be converted to a human-readable date and time format as needed.