breezeauth.com
EN
Sign inGet started free
Get startedIntroduction

Introduction

What BreezeAuth is, who this documentation is for and how it is organized.

On this page
  1. How this documentation is organized
  2. Conventions used in these pages
  3. Where to go next

BreezeAuth is an identity provider for small and medium businesses. It gives your organization one place to manage who your people are (identities), how they prove it (sign-in, multi-factor authentication, passkeys) and what they can access (applications connected through single sign-on).

This documentation explains how BreezeAuth works and how to get things done in the admin console. Most pages are written for administrators who are not necessarily developers. Some features, such as webhooks, also involve integration work. Those pages include technical sections for your developers, clearly marked as such.

How this documentation is organized

Section What you will find
Concepts The identity and access management (IAM) vocabulary used across the product, in plain language.
Organization Organization-wide security settings and the emergency actions for a security incident.
Domains How to verify your e-mail domains so your organization manages the accounts of its people.
Users How to add the people in your organization, invite guests, choose administrative roles and secure accounts.
Service users Identities for your integrations and automations: how to create them, manage their credentials and restrict them.
Groups How to organize people into groups, nest groups and give them access to applications.
Audit logs How to read and filter the history of everything that happens in your organization.
Webhooks How to receive real-time notifications when something changes in your organization.
SCIM provisioning How to let your HR platform or identity directory create and update users and groups automatically.

More sections will be added over time.

Conventions used in these pages

  • Names of screens, tabs, buttons and fields appear in bold, exactly as they are shown in the admin console, for example Organization › Webhooks › Add webhook.
  • Text in monospace is a technical value: a field name, a header, a URL or a piece of code.
  • Highlighted boxes call out information you should not miss:

Tip: a suggestion that makes something easier.

Important: something that can cause problems if ignored.

Where to go next

Last updated: October 13, 2026