Organization API¶
Enumerate tenants that are part of your organization and managed via Enterprise Admin.
See the guide for a narrative walkthrough of this API.
Base URL¶
https://api.central.sophos.com/organization/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 organization:listMembersaccount_management:writeorganization-permission-set:listorganization-role:createorganization-role:deleteorganization-role:listorganization-role:readorganization-role:update
Operations¶
Organization Admins¶
- List all admins
GET/admins - Create a new admin
POST/admins - Get an 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}
Organization 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}
OrganizationTenants¶
- Enumerate tenants
GET/tenants - Get tenant details
GET/tenants/{tenantId}
Download¶