Common API¶
Routine administrative actions across Sophos Fusion alerts, users and user groups.
Base URL¶
https://api-{dataRegion}.central.sophos.com/common/v1 — Regional service in the production environment.
| Variable | Description | Default | Allowed values |
|---|---|---|---|
dataRegion | Data region where tenant data is stored. | eu01 | eu01, eu02, us01, us03, ca01, au01, jp01, in01, br01, ae01 |
Authentication¶
Every request carries an Authorization: Bearer header with an access token obtained through the client-credentials flow — see Get started.
Operations¶
Alerts¶
- Query alerts
GET/alerts - Query alerts (POST)
POST/alerts/search - Get alert details
GET/alerts/{alertId} - Act on alert
POST/alerts/{alertId}/actions
Directory Management¶
- Query groups
GET/directory/user-groups - Add new group
POST/directory/user-groups - Get group
GET/directory/user-groups/{groupId} - Update group
PATCH/directory/user-groups/{groupId} - Delete group
DELETE/directory/user-groups/{groupId} - Users in group
GET/directory/user-groups/{groupId}/users - Add to group
POST/directory/user-groups/{groupId}/users - Remove from group
DELETE/directory/user-groups/{groupId}/users - Remove from group
DELETE/directory/user-groups/{groupId}/users/{userId} - Query users
GET/directory/users - Add new user
POST/directory/users - Get user
GET/directory/users/{userId} - Update user
PATCH/directory/users/{userId} - Delete user
DELETE/directory/users/{userId} - Groups of user
GET/directory/users/{userId}/groups - Add to groups
POST/directory/users/{userId}/groups - Remove from groups
DELETE/directory/users/{userId}/groups - Remove from group
DELETE/directory/users/{userId}/groups/{groupId}
tenant-access¶
See Guide for more on tenant-access.
- List all admins
GET/admins - Create new admin
POST/admins - Get admin by ID
GET/admins/{adminId} - Remove an admin
DELETE/admins/{adminId} - List all roles
GET/admins/{adminId}/role-assignments - Assign a role
POST/admins/{adminId}/role-assignments - Get role by ID
GET/admins/{adminId}/role-assignments/{assignmentId} - Remove a role
DELETE/admins/{adminId}/role-assignments/{assignmentId}
Tenant role management¶
- List all roles
GET/roles - Create new role
POST/roles - Get permission sets
GET/roles/permission-sets - Get role by ID
GET/roles/{roleId} - Patch role
PATCH/roles/{roleId} - Delete role by ID
DELETE/roles/{roleId}
Download¶