Partner API¶
Enumerate and provision MSP-managed tenants, manage admin access, and fetch billing reports.
See the guide for a narrative walkthrough of this API.
Base URL¶
https://api.central.sophos.com/partner/v1 — Global service in the production environment.
Authentication¶
Every request carries an Authorization: Bearer header with an access token obtained through the client-credentials flow — see Get started.
Required permissions¶
This API's operations require one or more of the following, depending on the operation — see each operation's own page for the exact requirement:
account_management:readaccount_management:read OR license_management:readaccount_management:read OR partner:listMembersaccount_management:writeaccount_management:write OR license_management:writelicense_management:writepartner-permission-set:listpartner-role:createpartner-role:deletepartner-role:listpartner-role:readpartner-role:update
Operations¶
Partner Admins¶
- List all admins
GET/admins - Create new admin
POST/admins - Get admin by ID
GET/admins/{adminId} - Delete 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}
Partner Billing¶
- Get usage report
GET/billing/usage/{year}/{month}
Partner 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}
Provisioning¶
- Available products
GET/provisioning/available-products - Default products
GET/provisioning/default-products - Default products
PATCH/provisioning/default-products - Default products
DELETE/provisioning/default-products
Tenants¶
- Enumerate tenants
GET/tenants - Create new tenant
POST/tenants - Get tenant details
GET/tenants/{tenantId} - Patch tenant details
PATCH/tenants/{tenantId} - Enumerate amendments
GET/tenants/{tenantId}/account-amendments - Make account changes
POST/tenants/{tenantId}/account-amendments - Get amendment by ID
GET/tenants/{tenantId}/account-amendments/{accountAmendmentId} - Delete amendment
DELETE/tenants/{tenantId}/account-amendments/{accountAmendmentId} - Select products
POST/tenants/{tenantId}/product-selection
Download¶