pysophoscentral

A Python client library for the Sophos Central API.

Status: work in progress (pre-1.0). The API surface is incomplete and may change between minor releases without notice. This release is published to reserve the package name; a stable 1.0 is on the roadmap.

Features

• OAuth2 client-credentials authentication and tenant resolution (whoami)
• Endpoints: list, read, filter (Endpoint API v1)
• Directory users: list, read, create, update, delete (Common API v1)
• Alerts and account health check
• Typed request/response models built on Pydantic v2

Requirements

• Python 3.12+

Installation

pip install pysophoscentral

Quickstart

Configuration is loaded from a TOML file:

# settings.toml
[sophos_central]
base_url = "https://api.central.sophos.com/"
auth_endpoint_url = "https://id.sophos.com/api/v2/oauth2/token"
auth_client_id = "<your-client-id>"
auth_client_secret = "<your-client-secret>"
api_version = "v1"

from pysophoscentral.api import SophosCentralClient
from pysophoscentral.settings import AppSettings

settings = AppSettings(_env_file="settings.toml")
client = SophosCentralClient(settings.sophos_central)

client.authenticate()   # obtain the OAuth2 access token
client.read_whoami()    # resolve tenant id and data region (required)

endpoints = client.read_endpoints()
for endpoint in endpoints.items:
    print(endpoint.id, endpoint.hostname)

Note: authenticate() and read_whoami() must be called, in this order, before any other API call.

License

MIT