Admin Tools

6 tools for managing workspace users, roles, permissions, and compliance audit logs.

Admin Scope Required
All admin tools require the admin:write scope. Only workspace owners and users with the Admin role can access these tools.

frontdesk_list_users

List all users in the workspace with their roles and status.

POSTtools/frontdesk_list_users
ParameterTypeDescription
rolestringFilter by role: owner, admin, staff, viewer.
statusstringFilter by status: active, invited, deactivated.Default: active
Response
200 OK
{
  "users": [
    {
      "id": "user_01",
      "name": "Dr. Sarah Johnson",
      "email": "sarah@riverside-dental.com",
      "role": "owner",
      "status": "active",
      "last_active": "2025-01-15T16:30:00Z"
    },
    {
      "id": "user_02",
      "name": "Michael Chen",
      "email": "michael@riverside-dental.com",
      "role": "staff",
      "status": "active",
      "last_active": "2025-01-15T15:45:00Z"
    }
  ],
  "total": 2
}

frontdesk_invite_user

Invite a new user to the workspace. An invitation email is sent with a link to set up their account.

POSTtools/frontdesk_invite_user
ParameterTypeDescription
emailrequiredstringEmail address to invite.
namerequiredstringName of the user.
rolerequiredstringRole to assign: admin, staff, viewer.

frontdesk_audit_log

Access the workspace audit log for compliance tracking. Records all significant actions including configuration changes, user management, and data access.

POSTtools/frontdesk_audit_log
ParameterTypeDescription
date_fromstringStart of date range.
date_tostringEnd of date range.
actor_idstringFilter by user who performed the action.
action_typestringFilter by action type: config_change, user_management, data_access.
limitnumberMax results.Default: 50
Response
200 OK
{
  "events": [
    {
      "id": "evt_01",
      "action": "config_change",
      "actor": { "id": "user_01", "name": "Dr. Sarah Johnson" },
      "details": "Updated business hours for Saturday",
      "timestamp": "2025-01-15T10:00:00Z",
      "ip_address": "198.51.100.42"
    },
    {
      "id": "evt_02",
      "action": "user_management",
      "actor": { "id": "user_01", "name": "Dr. Sarah Johnson" },
      "details": "Invited michael@riverside-dental.com with role: staff",
      "timestamp": "2025-01-14T09:30:00Z",
      "ip_address": "198.51.100.42"
    }
  ],
  "total": 2,
  "has_more": false
}

frontdesk_update_user_role

Change a user's role or deactivate their account. Role changes take effect immediately.

POSTtools/frontdesk_update_user_role
ParameterTypeDescription
user_idrequiredstringThe user to update.
rolestringNew role: admin, staff, viewer.
statusstringNew status: active, deactivated.

Search Documentation

Search for pages, tools, and guides