Administrative Guide

AuthForge provides powerful administrative capabilities for managing users, tenants, and auditing security events.

Audit Logs

The audit log captures all critical authentication and management events within your tenant.

Viewing Audit Logs

• Endpoint: GET /auth/admin/audit-logs
• Requires: audit:read permission.
• Parameters:
  • user_id (optional): Filter logs for a specific user.
  • action (optional): Filter by action (e.g., LOGIN, UPDATE_ROLE).
  • limit (default: 100): Number of logs to retrieve.
  • offset (default: 0): Pagination offset.

Example Response

[
  {
    "id": "uuid-v4",
    "user_id": "user-uuid",
    "action": "LOGIN",
    "resource": "tenant",
    "resource_id": "tenant-uuid",
    "ip_address": "127.0.0.1",
    "created_at": "2026-04-12T08:00:00Z",
    "payload": "..."
  }
]

User Management

Invite User

• Endpoint: POST /auth/admin/invite
• Requires: users:manage permission.

List Users

• Endpoint: GET /auth/admin/users
• Requires: users:read permission.

Get User Detail

• Endpoint: GET /auth/admin/users/{user_id}
• Requires: users:read permission.

Update User Status

Administrators can enable or disable user accounts. Disabled users cannot log in or refresh tokens.

• Endpoint: PATCH /auth/admin/users/{user_id}/status
• Requires: users:manage permission.
• Body:

  {
    "is_active": false
  }
  

Update User Role

• Endpoint: PATCH /auth/admin/users/{user_id}/role
• Requires: roles:assign permission.

Delete User

• Endpoint: DELETE /auth/admin/users/{user_id}
• Requires: users:manage permission.
• Note: You cannot delete your own account via this endpoint.

Tenant Management

Suspending a Tenant

Superadmins can deactivate entire tenants, blocking all users from that organization.

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