# Authgear ## Authgear - [Authgear Overview](https://docs.authgear.com/readme.md): Authgear is a highly adaptable identity-as-a-service (IDaaS) platform for web and mobile applications - [5-Minute Guide](https://docs.authgear.com/get-started/5-minute-guide.md): A quick guide on getting started with Authgear - [Skills for AI Agent](https://docs.authgear.com/get-started/ai-coding-tools.md) - [Start Building](https://docs.authgear.com/get-started/start-building.md): Choose the integration approach based on application type - [Single-Page App](https://docs.authgear.com/get-started/single-page-app.md): You need to protect a JavaScript SPA application that runs entirely in a browser - [JavaScript (Web)](https://docs.authgear.com/get-started/single-page-app/website.md): Integrate Authgear to your website with the Web SDK - [React](https://docs.authgear.com/get-started/single-page-app/react.md): Follow this quickstart tutorial to add authentication to your React application - [Angular](https://docs.authgear.com/get-started/single-page-app/angular.md): Follow this quickstart tutorial to add authentication to your Angular application - [Vue](https://docs.authgear.com/get-started/single-page-app/vue.md): Follow this quickstart tutorial to add authentication to your Vue application - [Native/Mobile App](https://docs.authgear.com/get-started/native-mobile-app.md): If you are developing mobile or desktop applications, choose from one of these SDKs for your platform to get started. - [iOS SDK](https://docs.authgear.com/get-started/native-mobile-app/ios.md): Integrate your iOS application with Authgear iOS SDK - [Android SDK](https://docs.authgear.com/get-started/native-mobile-app/android.md): How to use authgear android SDK - [Android Kotlin coroutine support](https://docs.authgear.com/get-started/native-mobile-app/android/coroutine-support.md) - [Android OKHttp Interceptor Extension (Optional)](https://docs.authgear.com/get-started/native-mobile-app/android/okhttp-interceptor-extension.md) - [Flutter SDK](https://docs.authgear.com/get-started/native-mobile-app/flutter.md): How to integrate with a Flutter app - [React Native SDK](https://docs.authgear.com/get-started/native-mobile-app/react-native.md): How to integrate with a React Native app - [Ionic SDK](https://docs.authgear.com/get-started/native-mobile-app/ionic.md): Guide on how to use Authgear in an Ionic project - [Xamarin SDK](https://docs.authgear.com/get-started/native-mobile-app/xamarin.md): How to integrate with a Xamarin app - [Using Authgear without SDK (Client side)](https://docs.authgear.com/get-started/native-mobile-app/using-authgear-without-sdk-client-side.md): Integrate Authgear on the client side in mobile apps without SDK - [Regular Web App](https://docs.authgear.com/get-started/regular-web-app.md): Traditional web app that runs on the server - [Next.js](https://docs.authgear.com/get-started/regular-web-app/nextjs.md): Authentication for Next.js app with Authgear - [Express](https://docs.authgear.com/get-started/regular-web-app/express.md): Authentication for Express.JS apps with Authgear and OAuth2 - [Python Flask App](https://docs.authgear.com/get-started/regular-web-app/python-flask-app.md): Authentication for a Python web application - [Java Spring Boot](https://docs.authgear.com/get-started/regular-web-app/java-spring-boot.md): Authentication for Spring Boot App with Authgear and OAuth2 - [ASP.NET Core MVC](https://docs.authgear.com/get-started/regular-web-app/asp.net-core-mvc.md): Add authentication for ASP.NET app with Authgear - [Laravel](https://docs.authgear.com/get-started/regular-web-app/laravel.md): Authentication for Laravel websites with Authgear and OAuth2 - [PHP](https://docs.authgear.com/get-started/regular-web-app/php.md): Authentication for PHP websites with Authgear and OAuth2 - [Backend/API Integration](https://docs.authgear.com/get-started/backend-api.md): An API or service protected by Authgear - [Client SDK to make authorized API calls to backend](https://docs.authgear.com/get-started/backend-api/using-sdk-to-call-your-application-server.md): How to make authorized request to your application server after login with Authgear - [Validate JWT in your backend](https://docs.authgear.com/get-started/backend-api/jwt.md): Authenticate the incoming HTTP requests by validating JWT in your application server - [Forward Authentication to Authgear Resolver Endpoint](https://docs.authgear.com/get-started/backend-api/nginx.md): Authenticate the incoming HTTP requests by forwarding Authentication to Authgear Resolver Endpoint - [NestJS API](https://docs.authgear.com/get-started/backend-api/nestjs.md): Protect a NestJS API with Authgear using the @authgear/nestjs SDK - [Machine-to-Machine (M2M) Applications](https://docs.authgear.com/get-started/m2m-applications.md): Enable secure, automated authorization for your backend systems, microservices, and IoT devices, ensuring only trusted apps and devices can access your APIs. - [Integration by OIDC](https://docs.authgear.com/get-started/oidc-provider.md): Using Authgear as an OpenID Connect Provider for any OIDC compatible applications for Single Sign-On. - [Integration by SAML](https://docs.authgear.com/get-started/single-sign-on-with-saml.md): Guides on how to use Authgear as a SAML Identity Provider for Single Sign-On - [Use Authgear as SAML Identity Provider for Salesforce](https://docs.authgear.com/get-started/single-sign-on-with-saml/use-authgear-as-saml-identity-provider-for-salesforce.md): A guide on how to use Authgear as a SAML Identity Provider IdP in Salesforce - [Use Authgear as SAML Identity Provider for Dropbox](https://docs.authgear.com/get-started/single-sign-on-with-saml/use-authgear-as-saml-identity-provider-for-dropbox.md): Guide on how to use Authgear as a SAML IdP for Dropbox - [SAML Attribute Mapping](https://docs.authgear.com/get-started/single-sign-on-with-saml/saml-attribute-mapping.md) - [Authentication](https://docs.authgear.com/authentication-and-access/authentication.md): Implement Authgear to control access to your applications - [Passwords](https://docs.authgear.com/authentication-and-access/authentication/passwords.md): Configure settings for both Primary and Secondary passwords - [Change Forgot/Reset Password settings](https://docs.authgear.com/authentication-and-access/authentication/passwords/forgot-reset-password-settings.md): Configure password reset/account recovery processes. - [Password Policy](https://docs.authgear.com/authentication-and-access/authentication/passwords/password-policy.md): Setting format and strength requirements for passwords - [Password Expiry](https://docs.authgear.com/authentication-and-access/authentication/passwords/password-expiry.md): Requiring users to reset their password if they haven't logged in after specific number of days - [How to Handle Password While Creating Accounts for Users](https://docs.authgear.com/authentication-and-access/authentication/passwords/how-to-handle-password-while-creating-accounts-for-users.md): Recommended practices for setting password for a user account created on the Authgear Portal - [Reset Password for Users](https://docs.authgear.com/authentication-and-access/authentication/passwords/reset-password-for-users.md): Guide on resetting a user's password via the Authgear Portal or AdminAPI - [Add Passkeys Login](https://docs.authgear.com/authentication-and-access/authentication/passkeys.md): Passkeys give users a simple and secure way to sign in to your apps and websites across platforms without passwords. - [Add WhatsApp OTP Login](https://docs.authgear.com/authentication-and-access/authentication/whatsapp-otp-login.md): Allow users to log into your app via OTP with WhatsApp, as a secure alternative to SMS - [Add Email Magic Link Login](https://docs.authgear.com/authentication-and-access/authentication/add-email-magic-link-login.md): Passwordless login with email links - [Add Biometric Login](https://docs.authgear.com/authentication-and-access/authentication/biometric.md) - [Add Anonymous Users](https://docs.authgear.com/authentication-and-access/authentication/anonymous-users.md): Allow guest users to use your apps and website and promote to regular users later. - [Enable Two-Factor Authentication (2FA)](https://docs.authgear.com/authentication-and-access/authentication/enable-two-factor-authentication-2fa.md): Guide on how to add Two-Factor Authentication to your application. - [Re-authentication](https://docs.authgear.com/authentication-and-access/authentication/reauthentication.md): Authgear provides an easy method to reauthenticate the end-users. You can use this as a security measure to protect sensitive operations. - [Add authentication to any web page](https://docs.authgear.com/authentication-and-access/authentication/add-authentication-to-any-web-page.md): Learn how to add authentication to any web page without using Authgear's SDKs with IIFE(Immediately-invoked Function Expression) bundle - [Disable Public Signup](https://docs.authgear.com/authentication-and-access/authentication/disable-public-signup.md) - [Custom Authentication Flow](https://docs.authgear.com/authentication-and-access/authentication/custom-authentication-flow.md): Allow users to authenticate with a custom flow. - [Single Sign-on Overview](https://docs.authgear.com/authentication-and-access/single-sign-on.md): Provide a seamless user experience across multiple applications with the single sign-on feature. - [App2App Login](https://docs.authgear.com/authentication-and-access/single-sign-on/app2app-authorization.md): Perform faster authentication flow via another app installed on the same device. - [App2Web (Pre-authenticated URLs)](https://docs.authgear.com/authentication-and-access/single-sign-on/pre-authenticated-urls.md): Use the pre-authenticated URLs feature to open a website from a native app in an authenticated state. - [Web2App (From Mobile Apps to Browsers)](https://docs.authgear.com/authentication-and-access/single-sign-on/sso-with-mobile-app-web-spa.md) - [Force Authgear to Show Login Page](https://docs.authgear.com/authentication-and-access/single-sign-on/force-authgear-to-show-login-page.md): Force Authgear to always show login page even if the user have already logged in. - [Social/Enterprise Login Providers Overview](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers.md): Add third-party identity providers to enable frictionless sign in for your users - [Social Login Providers](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/social-login-providers.md) - [Connect Apps to Apple](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/social-login-providers/apple.md) - [Connect Apps to Google](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/social-login-providers/google.md): Add Google Sign in to your apps in less than 5 minutes. - [Connect Apps to Facebook](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/social-login-providers/facebook.md): Add Facebook Sign in to your apps in less than 5 minutes. - [Connect Apps to GitHub](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/social-login-providers/github.md) - [Connect Apps to LinkedIn](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/social-login-providers/linkedin.md): Guide on how to add LinkedIn as a social login provider - [Connect Mobile Apps to WeChat](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/social-login-providers/wechat-mobile.md) - [Connect Websites to WeChat](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/social-login-providers/wechat-web.md) - [Enterprise Login Providers](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/enterprise-login-providers.md) - [Connect Apps to Microsoft Entra ID (Azure AD)](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/enterprise-login-providers/azureadv2.md) - [Connect Apps to Microsoft AD FS](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/enterprise-login-providers/adfs.md) - [Connect Apps to Azure AD B2C](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/enterprise-login-providers/azureadb2c.md) - [Force Social/Enterprise Login Providers to Show Login Screen](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/force-social-enterprise-login-providers-to-show-login-screen.md): Use OIDC prompt parameter to force OAuth providers to show login screen. - [Link and Unlink Social/Enterprise Provider with the SDK](https://docs.authgear.com/authentication-and-access/social-enterprise-login-providers/link-and-unlink-social-enterprise-provider-with-the-sdk.md) - [FAQ for Authentication](https://docs.authgear.com/faq-for-authentication.md) - [OTP Test Mode](https://docs.authgear.com/faq-for-authentication/otp-test-mode.md): Suppress message delivery and fix OTP for testing purposes - [Tips for Apple App Store Review with Passwordless Login](https://docs.authgear.com/faq-for-authentication/passwordless-demo-user-for-apple-app-review.md): How to pass the Apple Store review process if your app uses passwordless login. - [Phone Number Validation](https://docs.authgear.com/faq-for-authentication/phone-number-validation.md) - [Skip Login Screen and Direct Users to Enterprise Login](https://docs.authgear.com/faq-for-authentication/how-to-use-social-enterprise-login-providers-without-authui.md): Learn how to take users directly to an external OAuth provider's authorization page without opening AuthUI login page. - [Use the OAuth 2.0 State Parameter](https://docs.authgear.com/faq-for-authentication/how-to-use-the-oauth-2.0-state-parameter.md): Reference on what the OAuth 2.0 parameter is and how to use it in Authgear SDK. - [Local Dev Setup for Connecting to Authgear SaaS in Cookie-based Auth](https://docs.authgear.com/faq-for-authentication/local-cookie-based-web-setup.md): Setting up the local development environment for websites that use cookie-based authentication. - [Add custom fields to a JWT Access Token or ID Token](https://docs.authgear.com/integration/add-custom-fields-to-a-jwt-access-token.md): Learn how to add custom attributes to a JWT Access Token or ID Token using Authgear - [User Profiles](https://docs.authgear.com/integration/user-profiles.md) - [What is User Profile](https://docs.authgear.com/integration/user-profiles/user-profile.md) - [Access User Profiles](https://docs.authgear.com/integration/user-profiles/access-user-profiles.md): Learn how to access User Profiles - [Update User Profiles](https://docs.authgear.com/integration/user-profiles/update-user-profiles.md): Guide on the different ways you can modify the profiles of the users of your application. - [Profile Custom Attributes](https://docs.authgear.com/integration/user-profiles/profile-custom-attributes.md): Learn how to add custom attributes to user profiles and manage existing custom attributes - [Update user profile on sign-up using Hooks](https://docs.authgear.com/integration/user-profiles/update-user-profile-on-sign-up-using-hooks.md): Learn how to update a User profile's custom attributes on sign-up using Hooks - [Mobile Apps](https://docs.authgear.com/integration/mobile-apps.md): Learn how to integrate Authgear with mobile apps using SDKs and advanced configurations - [Force authentication on app launch](https://docs.authgear.com/integration/mobile-apps/force-authentication-on-app-launch.md) - [Customize the Login Pop-up / Disable the login alert box](https://docs.authgear.com/integration/mobile-apps/using-webview-to-open-the-authgear-ui.md): Learn how to switch between ASWebAuthenticationSession/Custom Tabs to WebKitWebView using Authgear Mobile SDKs. - [Integration with other Software](https://docs.authgear.com/integration/integration-with-other-software.md) - [Authgear and Supabase](https://docs.authgear.com/integration/integration-with-other-software/authgear-supabase.md): Guide on using Authgear together with Supabase database to deliver a secure and scalable application - [Authgear and Firebase](https://docs.authgear.com/integration/integration-with-other-software/authgear-firebase.md): Guide on how to use Authgear to secure Firebase services - [Integrate with Google Tag Manager](https://docs.authgear.com/integration/integration-with-other-software/user-analytics-by-google-tag-manager.md): Learn how to integrate popular analytics and tracking tools into your Authgear project using Google Tag Manager - [FAQ for Integration](https://docs.authgear.com/integration/faq-for-integration.md) - [How to Track User Before and After Signup?](https://docs.authgear.com/integration/faq-for-integration/track-user-before-and-after-signup.md): Learn how to track a user that signs up from a particular source or campaign. - [What happens with user directly access the Authgear Endpoint?](https://docs.authgear.com/integration/faq-for-integration/directly-accessing-authgear-endpoint.md): Endpoint Direct Access lets you configure what happens when users unexpectedly access your Authgear project endpoint without using OIDC/SDK/SAML. - [Built-in UI](https://docs.authgear.com/customization/built-in-ui.md): Authgear lets you customize your users’ entire authentication experience - [Branding in Auth UI](https://docs.authgear.com/customization/built-in-ui/branding.md): Customize the look and feel of Authgear to match your branding - [User Settings](https://docs.authgear.com/customization/built-in-ui/user-settings.md): Authgear offers prebuilt frontends for essential authentication features, including user settings pages. - [Privacy Policy & Terms of Service Links](https://docs.authgear.com/customization/built-in-ui/privacy-policy-terms-of-service.md) - [Customer Support Link](https://docs.authgear.com/customization/built-in-ui/customer-support-link.md): Let end-user to contact customer support in case they need help in the login process. - [Custom Text](https://docs.authgear.com/customization/built-in-ui/localization.md) - [Languages and Localization](https://docs.authgear.com/customization/built-in-ui/languages-and-localization.md): Change the default language for your Authgear project. - [Custom UI](https://docs.authgear.com/customization/custom-ui.md): Resources about setting up your own custom User Interface for Login, Signup, Account recovery and more. - [Authentication Flow API](https://docs.authgear.com/customization/custom-ui/authentication-flow-api.md): Learn about what the Authentication Flow API is and how to use it to implement your own custom user interface (UI) for authentication. - [Implement Authentication Flow API using Express](https://docs.authgear.com/customization/custom-ui/implement-authentication-flow-api-using-express.md): This post provides a simple guide for implementing a custom email + password login and signup pages using Authentication Flow API and Express. - [Implement Authentication Flow API using PHP](https://docs.authgear.com/customization/custom-ui/implement-authentication-flow-api-using-php.md): This guide shows how to setup custom login and signup pages using Authentication flow API. - [Add Custom Login/Signup UI to Native Apps](https://docs.authgear.com/customization/custom-ui/add-custom-login-signup-ui-to-native-apps.md): This guide shows how to use Custom Login/Signup pages UI in Native Apps - [Manually Link OAuth Provider using Account Management API](https://docs.authgear.com/customization/custom-ui/manually-link-oauth-provider-using-account-management-api.md): Use the Account Management API to link OAuth provider. - [Implement a custom account recovery UI using Authentication Flow API](https://docs.authgear.com/customization/custom-ui/implement-a-custom-account-recovery-ui-using-authentication-flow-api.md): Guide on how to implement your own account recovery UI powered by the Authentication Flow API - [Custom Domain](https://docs.authgear.com/customization/custom-domain.md) - [Custom Email and SMS Templates](https://docs.authgear.com/customization/custom-email-and-sms-templates.md): Modify the template for emails and SMS messages for your Authgear project. - [Custom Email Provider](https://docs.authgear.com/customization/custom-email-provider.md): Optimize for email deliverability by using your own SMTP server to send Authgear Emails (such as forgot password, verifications) in your own domains. - [Custom SMS Provider](https://docs.authgear.com/customization/custom-sms-provider.md): Guides for changing the default SMS provider to your own custom provider - [Twilio](https://docs.authgear.com/customization/custom-sms-provider/twilio.md): Use custom Twilio account as SMS provider for communication with the users. - [Webhook/Custom Script](https://docs.authgear.com/customization/custom-sms-provider/webhook-custom-script.md): Connect with any SMS providers with webhook or custom scripts for communication with the users. - [Events and Hooks](https://docs.authgear.com/customization/events-hooks.md) - [Blocking Events](https://docs.authgear.com/customization/events-hooks/blocking-events.md): Blocking events are triggered before the operation is performed. - [Non-blocking Events](https://docs.authgear.com/customization/events-hooks/non-blocking-events.md): Non-blocking events are delivered asynchronously after the operation is performed. - [JavaScript / TypeScript Hooks](https://docs.authgear.com/customization/events-hooks/denohooks.md): JavaScript / TypeScript Hooks is one of the supported hooks to receive events. - [Webhooks](https://docs.authgear.com/customization/events-hooks/webhooks.md): Use Webhooks for your Authgear project - [AMR (Authentication Method Reference)](https://docs.authgear.com/customization/events-hooks/amr.md) - [Example: Only Allow Signups from Inside the Corporate Network using Hooks](https://docs.authgear.com/customization/events-hooks/only-allow-signups-from-inside-the-corporate-network-using-hooks.md) - [Examples: Common Use Cases](https://docs.authgear.com/customization/events-hooks/examples-common-use-cases.md): Common usage of events and hooks to modify the behavior of an authentication on Authgear - [Monitor](https://docs.authgear.com/admin-and-operations/monitor.md) - [Audit Log For Users Activities](https://docs.authgear.com/admin-and-operations/monitor/audit-log.md) - [Audit Log for Admin API and Portal](https://docs.authgear.com/admin-and-operations/monitor/audit-log-for-admin-api-and-portal.md) - [Analytics](https://docs.authgear.com/admin-and-operations/monitor/analytics.md): See information about the total number users and active users on your Authgear project - [User Management](https://docs.authgear.com/admin-and-operations/user-management.md) - [Account Deletion](https://docs.authgear.com/admin-and-operations/user-management/account-deletion.md): Allow end-users to initiate account deletion within the apps. - [Import Users using User Import API](https://docs.authgear.com/admin-and-operations/user-management/import-users-using-user-import-api.md): Use the user import API to bulk import users from external systems to your Authgear project - [Export Users using the User Export API](https://docs.authgear.com/admin-and-operations/user-management/export-users-using-the-user-export-api.md): Export users from your project into a CSV or JSON file - [Manage Users Roles and Groups](https://docs.authgear.com/admin-and-operations/user-management/manage-users-roles-and-groups.md): Define and manage roles and groups that you can apply to your users - [Disable User](https://docs.authgear.com/admin-and-operations/user-management/disable-user.md): Temporarily or permanently suspend a user’s ability to log in and use the system - [Account Valid Period](https://docs.authgear.com/admin-and-operations/user-management/account-valid-period.md): Use account valid period to manage temporary access - [Migration](https://docs.authgear.com/admin-and-operations/migration.md): Strategy for migrating from another auth provider to Authgear. - [Bulk migration](https://docs.authgear.com/admin-and-operations/migration/bulk-migration.md) - [Rolling migration](https://docs.authgear.com/admin-and-operations/migration/rolling-migration.md) - [Zero-downtime migration](https://docs.authgear.com/admin-and-operations/migration/zero-downtime-migration.md) - [Brute-force Protection](https://docs.authgear.com/security/brute-force-protection.md): Account Lockout Policy safeguards attacks towards a user account from brute-force login attempts - [Bot Protection](https://docs.authgear.com/security/bot-protection.md): Use bot protection tools to block automated attackers - [IP Blocklist](https://docs.authgear.com/security/ip-blocklist.md): IP Blocklist allows you to block incoming traffic based on IP addresses or geographic regions. - [Non-HTTP scheme redirect URI](https://docs.authgear.com/security/redirect-uri.md): Implication of using non-HTTP scheme in redirect URI. - [Sender Constraining](https://docs.authgear.com/security/sender-constraining.md): Sender constrain refresh tokens in Authgear - [APIs](https://docs.authgear.com/reference/apis.md): Authgear exposes APIs for developers to manage their applications programmatically - [Admin API](https://docs.authgear.com/reference/apis/admin-api.md): The Admin API allows your server to manage users via a GraphQL endpoint. - [Authentication and Security](https://docs.authgear.com/reference/apis/admin-api/authentication-and-security.md): The Admin API is protected by cryptographic keys. Learn how to generate a valid JWT to authorize your request in this article. - [API Schema](https://docs.authgear.com/reference/apis/admin-api/api-schema.md) - [API Queries and Mutations](https://docs.authgear.com/reference/apis/admin-api/api-queries-and-mutations.md): In this section of the Authgear documentation, you'll learn about all the GraphQL queries and mutations the Admin API supports. - [Using global node IDs](https://docs.authgear.com/reference/apis/admin-api/using-global-node-ids.md) - [Retrieving users using Admin API](https://docs.authgear.com/reference/apis/admin-api/retrieving-users-using-admin-api.md): Overview and examples for the getUser/getUsers queries - [API Examples](https://docs.authgear.com/reference/apis/admin-api/api-examples.md): Learn how to perform common actions from the examples - [Generate OTP code](https://docs.authgear.com/reference/apis/admin-api/api-examples/generate-otp-code.md) - [Search for users](https://docs.authgear.com/reference/apis/admin-api/api-examples/search-for-users.md) - [Update user's picture](https://docs.authgear.com/reference/apis/admin-api/api-examples/update-users-picture.md) - [Update user's standard attributes](https://docs.authgear.com/reference/apis/admin-api/api-examples/update-users-standard-attributes.md) - [Authentication Flow API](https://docs.authgear.com/reference/apis/authentication-flow-api.md): API reference detailing all endpoints, inputs and results supported by the Authentication Flow API. - [OAuth 2.0 and OpenID Connect (OIDC)](https://docs.authgear.com/reference/apis/oauth-2.0-and-openid-connect-oidc.md): Reference for configurations and endpoints in the industry-standard protocols OAuth 2.0 or OpenID Connect. - [Supported Scopes](https://docs.authgear.com/reference/apis/oauth-2.0-and-openid-connect-oidc/supported-scopes.md): Details about the OAuth 2.0 Scopes Authgear supports - [UserInfo](https://docs.authgear.com/reference/apis/oauth-2.0-and-openid-connect-oidc/userinfo.md): Complete list of information in the UserInfo endpoint response. - [User Import API](https://docs.authgear.com/reference/apis/user-import-api.md): API Reference for the User Import API that developers can use to bulk import users from another system to their Authgear project. - [User Export API](https://docs.authgear.com/reference/apis/user-export-api.md): API Reference for the User Export API - [Tokens](https://docs.authgear.com/reference/tokens.md): Description of what's in Authgear's JWT access token and UserInfo endpoint response. - [JWT Access Token](https://docs.authgear.com/reference/tokens/jwt-access-token.md): Claims in JWT Access Token - [Refresh Token](https://docs.authgear.com/reference/tokens/refresh-token.md): Learn about refresh token, how to get a refresh token and how to use it to get a new access token. - [M2M Tokens](https://docs.authgear.com/reference/tokens/m2m-tokens.md) - [Rate Limits](https://docs.authgear.com/reference/rate-limits.md): Learn about the rate limits for different services and resources. - [Account Lockout](https://docs.authgear.com/reference/rate-limits/account-lockout.md): Learn about default way account lockout works, and how to customise lockout limits - [Glossary](https://docs.authgear.com/reference/glossary.md): Definitions of the most common technical terms you will come across while working with Authgear and implementing user authentication to your application. - [Billing FAQ](https://docs.authgear.com/reference/billing-faq.md): Frequently asked questions on how billing works on Authgear - [What is Authgear ONCE](https://docs.authgear.com/authgear-once/what-is-authgear-once.md) - [Install Authgear ONCE on a VM](https://docs.authgear.com/authgear-once/install-authgear-once-on-a-vm.md): General guide on installing Authgear ONCE - [Install Authgear ONCE on Amazon Web Services (AWS)](https://docs.authgear.com/authgear-once/install-authgear-once-on-amazon-web-services-aws.md): Guide on how to install Authgear ONCE on an AWS EC2 Instance - [Install Authgear ONCE on Vultr](https://docs.authgear.com/authgear-once/install-authgear-once-on-vultr.md): Step-by-step guide for installing Authgear ONCE on Vultr VM - [Identity Fundamentals](https://docs.authgear.com/concepts/identity-fundamentals.md) - [Authgear use cases](https://docs.authgear.com/concepts/authgear-use-cases.md): Take a look at just a few of Authgear's use cases - [User, Identity and Authenticator](https://docs.authgear.com/concepts/user-identity-and-authenticator.md) - [How Authgear integrate with your applications](https://docs.authgear.com/concepts/how-authgear-integrate-with-your-applications.md) - [Deploy with Helm chart](https://docs.authgear.com/deployment/helm.md) - [Authenticating HTTP request with Nginx](https://docs.authgear.com/deployment/auth-nginx.md): How to authenticate HTTP request with Nginx - [Run locally with Docker Compose](https://docs.authgear.com/deployment/local.md): How to run Authgear locally with Docker Compose. - [Configuration](https://docs.authgear.com/deployment/configuration.md): How Authgear is configured - [Environment Variables](https://docs.authgear.com/deployment/configuration/env.md): Environment variables provides global configuration - [authgear.yaml](https://docs.authgear.com/deployment/configuration/authgear.yaml.md): This is the main configuration file affecting every aspect of Authgear. - [authgear.secrets.yaml](https://docs.authgear.com/deployment/configuration/authgear.secrets.yaml.md): This is the configuration file containing various secrets used in Authgear. - [Architecture Guides](https://docs.authgear.com/deployment/architecture-guides.md) - [AWS Reference Architecture](https://docs.authgear.com/deployment/architecture-guides/aws-reference-architecture.md) - [Azure Reference Architecture](https://docs.authgear.com/deployment/architecture-guides/azure-reference-architecture.md) - [Google Cloud Reference Architecture](https://docs.authgear.com/deployment/architecture-guides/google-cloud-reference-architecture.md) - [On-Premises Reference Architecture](https://docs.authgear.com/deployment/architecture-guides/on-premises-reference-architecture.md) - [Throughput Scaling Reference](https://docs.authgear.com/deployment/architecture-guides/throughput-scaling-reference.md) - [How to Fix SubtleCrypto: digest() undefined Error in Authgear SDK](https://docs.authgear.com/troubleshooting/how-to-fix-subtlecrypto-digest-undefined-error-in-authgear-sdk.md): Guide on how to fix SubtleCrypto: digest() non-HTTPS/Secure context Error in Authgear SDK - [How to Fix CORS Error](https://docs.authgear.com/troubleshooting/how-to-fix-cors-error.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.authgear.com/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.