API Reference

WebStream exposes APIs for managing identity and access and for reading activity and audit data. This page points to the canonical references and the open-source repository.

IAM API

The IAM API manages organizations, users, groups, applications, workspaces, and policies under /iam/*. It is the programmatic equivalent of the admin console's setup sections, suitable for automation and infrastructure-as-code.

The same operations are available from the command line via webstream.exe. For a full command catalogue with examples, see the CLI Scripting Guide.

# Example: create an organization via the management CLI
webstream.exe -add-org "Acme Corp"

Activity API

The Activity API exposes session and activity audit data collected by the Metrics Engine, for integration with SIEM and reporting tools. The same data backs the Activity and Session logs in Reports.

MCP interface

Both APIs are also exposed to AI assistants (Claude, Cursor, ChatGPT) through the bundled webstream-ops-mcp server, which adds privacy masking and per-key tool allowlists on top of the Gateway's /mcp/* proxy. See the MCP Interface reference for setup, security controls, and the tool catalogue.

Source and samples

The open-source ActiveX control, API samples, issues, and community contributions live in the WebStream GitHub repository at github.com/audentiadev/webstream-core.

Note

For configuration workflows that combine these APIs — creating an organization, then users, groups, apps, workspaces, and policies — follow the same sequence shown in Phase 2 — Custom Setup.