Skip to content

Administrative API

AuthForge provides a set of endpoints for managing users and tenants at scale.

User Management

List Users

  • Endpoint: GET /auth/admin/users
  • Requires: users:read permission.
  • Returns: A list of all users in the currently authenticated tenant.

Update User Role

  • Endpoint: PATCH /auth/admin/users/{user_id}/role
  • Requires: roles:assign permission.
  • Hierarchy: You cannot assign a role higher or equal to your own.

Tenant Management

Update Tenant Status

  • Endpoint: PATCH /auth/admin/tenants/{tenant_id}/status
  • Requires: tenant:manage permission (Superadmin only).
  • Actions: Suspend or reactivate a tenant.