DOCSEARCHbyAlgolia
Submit Docs

PropelAuth Documentation

website·Indexed 35 days ago

https://docs.propelauth.com

Authentication and authorization platform specializing in B2B and multi-tenant applications. Features include Role Based Access Control (RBAC), organization management, and a CLI for rapid setup. Provides SDKs for Next.js (App and Pages Router), React, FastAPI, Flask, Go, Rust (Axum, Actix), and Cloudflare Workers, as well as OAuth2, Social Login, and Step-Up MFA APIs.

Tokens
116.3K
Snippets
432
Records
725
Agent score
64%

What's inside PropelAuth

  1. Overview of PropelAuth API Key Authentication

    API Key authentication allows you to protect requests made to your product from outside a browser, such as via CLIs or cURL. Users generate a key, send it in their request headers, and your backend validates the key via PropelAuth's validation API to identify the associated user or organization.

  2. Overview of PropelAuth transactional emails

    PropelAuth provides built-in management for transactional emails, meaning no external email provider is required by default. It handles common user actions such as passwordless logins, password reset emails, and organization invitations. These emails automatically inherit the color scheme and style configured for your hosted authentication pages.

  3. Overview of PropelAuth Environments

    PropelAuth provides three isolated environments—Test, Staging, and Production—to separate development workflows. Each environment maintains its own independent set of users, organizations, API keys, and Auth URLs. Users can switch between these environments using the 'Preview' toggle in the top right of the PropelAuth dashboard.

  4. Overview of PropelAuth Integrations

    PropelAuth provides a variety of integrations to extend the functionality of user management and authentication. Available integrations include:

    • Notifications & Communication: Slack (alerts for new user signups).
    • Analytics & User Behavior: PostHog (user identification), Google Analytics (demographics and metrics), and Google Tag Manager (behavior tracking).
    • Infrastructure & Automation: Webhooks (HTTP requests for events) and Terraform (programmatic settings management).
    • Logging & Compliance: Amazon S3 and Datadog (Audit Log exports).
    • Security: Cloudflare Turnstile (bot and spam protection for signup/login).
    • CRM: HubSpot (syncing users and organizations).
    • Payments: Stripe (linking organizations to customers - coming soon).

  5. Overview of PropelAuth SCIM Support

    SCIM (System for Cross-domain Identity Management) automates user account management for enterprise customers. When a customer adds, updates, or removes an employee in their Identity Provider (IdP), those changes are automatically reflected in PropelAuth. Users are automatically added to their respective PropelAuth organizations, meaning existing organization-based code does not need to be modified to support SCIM.

  6. Overview of PropelAuth Hosted Pages

    Hosted pages are pre-built, customizable web pages hosted by PropelAuth that handle critical authentication and management flows, including signup, login, and invite flows. These pages integrate with your application and can be customized via the PropelAuth Dashboard to match your branding.

  7. Overview of PropelAuth Organizations

    Organizations in PropelAuth are groups of users who use a product together. They are used to implement multi-tenancy and can be referred to as companies, tenants, teams, workspaces, or shared accounts. Organizations can be created by end-users via hosted pages, manually via the PropelAuth dashboard, or programmatically via APIs.

  8. Overview of PropelAuth Multi-Tenant Auth

    PropelAuth is an all-in-one solution for multi-tenant authentication and authorization designed specifically for B2B businesses. It provides tools for managing users, organizations, and API key authentication to protect product requests.

  9. Overview of PropelAuth Multi-Factor Authentication (MFA)

    PropelAuth provides a hosted account page with a built-in MFA enrollment UI, allowing users to enroll in MFA, view backup codes, and disable MFA without requiring additional custom code. PropelAuth supports two types of MFA: TOTP (Time-based One-Time Password) via Authenticator Apps and SMS-based MFA.

  10. Overview of PropelAuth Integration Options

    PropelAuth provides two primary ways to integrate authentication and authorization into an application:

    1. Libraries: Pre-built libraries for Frontend, Fullstack, and Backend environments. These are used for protecting APIs, performing authorization checks, and simplifying the integration process.
    2. APIs: Programmatic endpoints used for high-control tasks such as sending invites, disabling users, and managing tenants.

  11. Overview of PropelAuth B2B Authentication Features

    PropelAuth provides end-to-end managed user authentication specializing in B2B use cases. Key capabilities include:

    • Organization Management: Built-in support for organizations, allowing users to invite coworkers or auto-join via work emails.
    • Enterprise SSO: Integration with SAML and OIDC providers (e.g., Okta, Entra ID) supporting password, magic link, or SSO logins.
    • RBAC (Role-Based Access Control): Support for default or custom roles and permissions.
    • Security: Two-factor authentication (2FA), MFA enforcement, and customizable user session durations.
    • API Key Management: Ability for users and organizations to create API keys for secure API access, which automatically invalidate if the user or org is blocked/deleted.
    • MCP Authentication: Support for protecting AI Agents and Model Context Protocol (MCP) servers.

  12. Overview of PropelAuth SSO and Social Login options

    PropelAuth provides two primary ways to handle external authentication:

    1. SSO / Social Logins: Allows customers to sign in using social providers such as Google, Microsoft, Apple, GitHub, and others.
    2. Enterprise SSO Only: Designed for organizations that already have an existing authentication provider but need to add support for Enterprise SSO / SAML. In this mode, PropelAuth acts as an identity provider alongside the existing system.