connections

List

Filter-scoped by role: a platform admin sees their own tenant's connections by default (tenant_id for another tenant, all_tenants=true for every tenant), tenant_admin sees their own tenant's, user/developer see none. List rows never carry config — only Get/Create/Update return a (redacted) config, and even those never return raw credentials. Filters only narrow that scope; total counts the rows matching every filter. q never searches config. Unknown provider/status values match nothing; an unknown sort falls back to created.

get/connections

Request

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

Query parameters

qstring

case-insensitive substring of the connection name or public provider_app_id (never config)

providerstring

csv of provider names (OR), e.g. sendgrid,privy — see GET /connections/providers

status'active' | 'inactive'

csv of statuses (OR)

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

sort field

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.