Skip to main content

Authentication

Authentication in Breeze helps you control how users access the platform and manage their login experience. This page gives you an overview of the authentication features available and points you to detailed guides.

What is Authentication?​

Authentication is the process of verifying a user's identity when they log in to Breeze. It ensures that only authorized users can access your organization's data and features.

Authentication Features​

Single Sign-On (SSO)​

Single Sign-On (SSO) allows users to access Breeze using their existing organizational credentials. Instead of creating separate Breeze accounts, users can log in once with their company credentials and gain access to Breeze seamlessly.

Key Benefits:

  • Convenience: Users only need to remember one set of credentials
  • Security: Reduces password-related security risks
  • Efficiency: Eliminates the need for multiple logins
  • User Experience: Provides seamless access to Breeze

Breeze supports SSO integration with:

  • Azure Active Directory (Azure AD) - Available out of the box
  • Other Identity Providers - Available upon request (SAML, OAuth2, or OpenID Connect)
info

SSO Availability: SSO is available for Enterprise plans only.
Contact your dealer or Breeze representative to learn more about our Enterprise plans.

OAuth API Authentication​

OAuth API Authentication enables secure, programmatic access to the Breeze API using industry-standard OAuth 2.0 tokens. This authentication method is designed for machine-to-machine integrations, automated systems, and service-to-service communication.

Key Benefits:

  • Security: Short-lived tokens (1 hour default) reduce exposure if compromised
  • Standards-Based: Uses industry-standard OAuth 2.0 Client Credentials flow
  • Flexible: Supports automated workflows, integrations, and scheduled jobs
  • Auditable: All authentication events are logged for security and compliance

Use Cases:

  • External system integrations
  • Automated reporting and data synchronization
  • CI/CD pipeline access
  • Partner API access
  • Service-to-service communication

Getting Started​

To learn more about setting up and managing authentication in Breeze, explore the following sections:

Common Tasks​

  • Authenticate API requests using OAuth 2.0 tokens
  • Set up SSO integration with your identity provider
  • Configure user onboarding workflows
  • Manage user roles and access permissions
  • Create custom SSO login routes
  • Monitor authentication activity

For detailed instructions on these tasks, see the SSO documentation.