groups

List

Every group in the caller's tenant (the policy's baseline group-read rule — any authenticated member of a tenant may list its groups). q searches name/description, type_id filters to one group_type, sort is name (A-Z, default) | name_desc | recent | oldest. Groups of a RESERVED type (a service's, e.g. enforcer-graph's per-DAG sharing groups) are omitted unless include_reserved=true or type_id names that type. Archived groups are omitted unless archived=true|all.

get/groups

Request

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

Query parameters

qstring

search name or description

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

name (A-Z, default) | name_desc | recent | oldest; an unknown value falls back to name

type_idstring

filter by group type id

include_reservedboolean

also list groups of RESERVED types (service-managed, e.g. enforcer-graph's per-DAG sharing groups); hidden by default. A type_id naming a reserved type lists them regardless.

archived'false' | 'true' | 'all'

archive state: false (default) = live groups only, true = archived only, all = both. Any other value is 400 invalid_archived

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.