tenants

List

Tenants visible to the caller, in the caller's tenant scope: by default the caller's OWN tenant (a platform admin included); a platform admin passes all_tenants=true for every tenant (the workspace directory) or tenant_id for one. A tenant admin sees their own; anyone else sees none. q matches part of a name, or a whole join code (never part of one, so the search cannot spell out a code the caller may not see); status filters active/inactive/suspended. Each tenant's code (the join secret) is present only for a platform admin or that tenant's own tenant_admin; every other caller gets it stripped to null, not omitted.

get/tenants

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/tenants
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Query parameters

qstring

part of a name, or a whole join code

status'active' | 'inactive' | 'suspended'

filter by status

sort'name' | 'name_desc' | 'recent' | 'oldest'

sort order

limitinteger

page size

offsetinteger

page offset

tenant_idstring uuid

list this tenant instead of your own (default: the caller's own tenant, platform admins included). Another tenant requires the cross_tenant grant — 403 otherwise

all_tenantsboolean

list EVERY tenant (platform-wide admin view). Requires the cross_tenant grant — 403 otherwise. Mutually exclusive with tenant_id (400 conflicting_tenant_scope)

Response

OK

limitinteger
offsetinteger
successboolean
totalinteger

Example response

{
  "success": true
}

Changes

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