SUMMARY.md

Table of contents

• Authgear Overview

Get Started

• 5-Minute Guide
• Skills for AI Agent
• Start Building
• Single-Page App
  • JavaScript (Web)
  • React
  • Angular
  • Vue
• Native/Mobile App
  • iOS SDK
  • Android SDK
    • Android Kotlin coroutine support
    • Android OKHttp Interceptor Extension (Optional)
  • Flutter SDK
  • React Native SDK
  • Ionic SDK
  • Xamarin SDK
  • Using Authgear without SDK (Client side)
• Regular Web App
  • Next.js
  • Express
  • Python Flask App
  • Java Spring Boot
  • ASP.NET Core MVC
  • Laravel
  • PHP
• Backend/API Integration
  • Client SDK to make authorized API calls to backend
  • Validate JWT in your backend
  • Forward Authentication to Authgear Resolver Endpoint
  • NestJS API
• Machine-to-Machine (M2M) Applications
• Integration by OIDC
• Integration by SAML
  • Use Authgear as SAML Identity Provider for Salesforce
  • Use Authgear as SAML Identity Provider for Dropbox
  • SAML Attribute Mapping

Authentication and Access

• Authentication
  • Passwords
    • Change Forgot/Reset Password settings
    • Password Policy
    • Password Expiry
    • How to Handle Password While Creating Accounts for Users
    • Reset Password for Users
  • Add Passkeys Login
  • Add WhatsApp OTP Login
  • Add Email Magic Link Login
  • Add Biometric Login
  • Add Anonymous Users
  • Enable Two-Factor Authentication (2FA)
  • Re-authentication
  • Add authentication to any web page
  • Disable Public Signup
  • Custom Authentication Flow
• Single Sign-on Overview
  • App2App Login
  • App2Web (Pre-authenticated URLs)
  • Web2App (From Mobile Apps to Browsers)
  • Force Authgear to Show Login Page
  • Single Sign-on with OIDC
  • Single Sign-on with SAML
• Social/Enterprise Login Providers Overview
  • Social Login Providers
    • Connect Apps to Apple
    • Connect Apps to Google
    • Connect Apps to Facebook
    • Connect Apps to GitHub
    • Connect Apps to LinkedIn
    • Connect Mobile Apps to WeChat
    • Connect Websites to WeChat
  • Enterprise Login Providers
    • Connect Apps to Microsoft Entra ID (Azure AD)
    • Connect Apps to Microsoft AD FS
    • Connect Apps to Azure AD B2C
  • Force Social/Enterprise Login Providers to Show Login Screen
  • Link and Unlink Social/Enterprise Provider with the SDK

---

• FAQ for Authentication
  • OTP Test Mode
  • Tips for Apple App Store Review with Passwordless Login
  • Phone Number Validation
  • Skip Login Screen and Direct Users to Enterprise Login
  • Use the OAuth 2.0 State Parameter
  • Local Dev Setup for Connecting to Authgear SaaS in Cookie-based Auth

Integration

• Add custom fields to a JWT Access Token or ID Token
• User Profiles
  • What is User Profile
  • Access User Profiles
  • Update User Profiles
  • Profile Custom Attributes
  • Update user profile on sign-up using Hooks
• Mobile Apps
  • Force authentication on app launch
  • Customize the Login Pop-up / Disable the login alert box
• Integration with other Software
  • Authgear and Supabase
  • Authgear and Firebase
  • Integrate with Google Tag Manager
• FAQ for Integration
  • How to Track User Before and After Signup?
  • What happens with user directly access the Authgear Endpoint?

Customization

• Built-in UI
  • Branding in Auth UI
  • User Settings
  • Privacy Policy & Terms of Service Links
  • Customer Support Link
  • Custom Text
  • Languages and Localization
• Custom UI
  • Authentication Flow API
  • Implement Authentication Flow API using Express
  • Implement Authentication Flow API using PHP
  • Add Custom Login/Signup UI to Native Apps
  • Manually Link OAuth Provider using Account Management API
  • Implement a custom account recovery UI using Authentication Flow API
• Custom Domain
• Custom Email and SMS Templates
• Custom Email Provider
• Custom SMS Provider
  • Twilio
  • Webhook/Custom Script
• Events and Hooks
  • Blocking Events
  • Non-blocking Events
  • JavaScript / TypeScript Hooks
  • Webhooks
  • AMR (Authentication Method Reference)
  • Example: Only Allow Signups from Inside the Corporate Network using Hooks
  • Examples: Common Use Cases

Admin & Operations

• Monitor
  • Audit Log For Users Activities
  • Audit Log for Admin API and Portal
  • Analytics
• User Management
  • Account Deletion
  • Import Users using User Import API
  • Export Users using the User Export API
  • Manage Users Roles and Groups
  • Disable User
  • Account Valid Period
• Migration
  • Bulk migration
  • Rolling migration
  • Zero-downtime migration

Security

• Brute-force Protection
• Bot Protection
• IP Blocklist
• Non-HTTP scheme redirect URI
• Sender Constraining

Reference

• APIs
  • Admin API
    • Authentication and Security
    • API Schema
    • API Queries and Mutations
    • Using global node IDs
    • Retrieving users using Admin API
    • API Examples
      • Generate OTP code
      • Search for users
      • Update user's picture
      • Update user's standard attributes
  • Authentication Flow API
  • OAuth 2.0 and OpenID Connect (OIDC)
    • Supported Scopes
    • UserInfo
  • User Import API
  • User Export API
• Tokens
  • JWT Access Token
  • Refresh Token
  • M2M Tokens
• Rate Limits
  • Account Lockout
• Glossary
• Billing FAQ

Authgear ONCE

• What is Authgear ONCE
• Install Authgear ONCE on a VM
• Install Authgear ONCE on Amazon Web Services (AWS)
• Install Authgear ONCE on Vultr

Concepts

• Identity Fundamentals
• Authgear use cases
• User, Identity and Authenticator
• How Authgear integrate with your applications

Client App SDKs

• Javascript SDK Reference
• iOS SDK Reference
• Android SDK Reference
• Flutter SDK Reference
• Xamarin SDK Reference

Deployment

• Deploy with Helm chart
• Authenticating HTTP request with Nginx
• Run locally with Docker Compose
• Configuration
  • Environment Variables
  • authgear.yaml
  • authgear.secrets.yaml
• Architecture Guides
  • AWS Reference Architecture
  • Azure Reference Architecture
  • Google Cloud Reference Architecture
  • On-Premises Reference Architecture
  • Throughput Scaling Reference

Troubleshooting

• How to Fix SubtleCrypto: digest() undefined Error in Authgear SDK
• How to Fix CORS Error