Organization Admin

Suspend an organization

Stops the organization changing anything — ingest included — until it is reinstated. Reads keep working, so the tenant can sign in and be shown why. Independent of billing status, so a payment does not lift it. A signed-in platform admin's own address is recorded as suspendedBy.

post/api/v1/admin/organizations/{organizationId}/suspend

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/admin/organizations/{organizationId}/suspend
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Platform-Admin-Token

Path parameters

organizationIdstring uuid required

Request body

reasonstring required
suspendedBystring

Response

Suspended

Changes

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