Admin API Reference
The Admin API is a JSON-over-HTTP RPC API. Every method is invoked with a POST request and a JSON body.
Authentication: Bearer JWT issued by the configured identity provider. Admin-level scope required.
Services
Section titled “Services”| Service | Base path | Description |
|---|---|---|
| Accounts | /accounts | AccountsService provides operations for managing accounts. |
| Aliases | /aliases | AliasesService provides operations for managing aliases. |
| Audit | /audit | AuditService provides access to audit logs for admin operations |
| Change Requests | /change-requests | |
| Domains | /domains | DomainsService manages domain configuration for email sending via AWS SES |
| Email Identities | /email-identities | EmailIdentitiesService manages email identities for AWS SES |
| Idp Users | /idp-users | IdpUsersService provides operations for managing IdP users (provider-specific). |
| Mail Feedback | /mail-feedback | MailFeedbackService provides access to bounce and complaint feedback |
| Monitoring | /monitoring | MonitoringService provides low-cost, on-demand observability endpoints for the Admin UI |
| Status | /status | |
| Suppression | /suppression | SuppressionService provides operations for managing recipient suppressions |
| Users | /users | UsersService provides operations for managing users. |