Principal Types

The Public API accepts two kinds of credentials. Each one resolves to a different set of capabilities.

User JWT

A user token represents a person signed in to Breezy. It is scoped to your company and can perform user-only actions such as API key management.

Service API key

A service API key represents an automation rather than a person. It is scoped to your company and is the right choice for server-to-server integrations, but it intentionally cannot manage API keys. Choose a user JWT when a request must manage API keys or act as a specific user. Choose a service API key for unattended automation.