group-types

List

Search the caller's visible group-type catalog: global types (tenant_id NULL, the admin-managed cross-tenant set) plus ONE tenant's types, in one list — the caller's own by default (platform admins included); a platform admin may pass tenant_id for another tenant or all_tenants=true for every tenant's types. Global types are included in every scope. q matches name or description. total counts the rows matching q; an unknown sort falls back to the default order.

get/group-types

Request

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

Query parameters

qstring

search name or description

sort'name' | 'slug' | 'created' | 'updated'

sort field; absent keeps the default order (global types first, then name A-Z)

sort_dir'asc' | 'desc'

sort direction (id breaks ties in the same direction)

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.