MethodPathSummaryAuth
GET/v1/admin/site-groupsList all tenant site groups for a platform administratorSession

Contract file:api/control-site-groups.openapi.yaml

Operation details

GET /v1/admin/site-groups

List all tenant site groups for a platform administrator

operationId
listAdminSiteGroups
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

All of:sites.read identity.users.manage

Description (from the contract)

Requires a live platform identity and both permissions under shared IAM rules. Tenant credentials are rejected even when they contain similarly named permissions. No scope override is accepted. Count and page come from one database snapshot. Groups are ordered by created_at, id, scope_id ascending. A user is returned only when the scope has exactly one non-deleted system tenant_owner with an active membership. Missing or multiple owners are explicit; the actor or first member is never substituted.

Parameters

listAdminSiteGroups Parameters
NameInTypeRequiredDescription
pagequeryintegerNo—
limitqueryintegerNo—

Responses

listAdminSiteGroups Responses
StatusDescription
200Complete scoped-resource rows and a real global total.

Fields:items: array<AdminSiteGroup> total: integer page: integer limit: integer

400Invalid request or precondition. A refused name or remark is validation_error with error.details {field: name|remark, reason}.
401Authentication required.
403Permission denied.
503Site group service unavailable.

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list