¶ User Guide Overview

Welcome to the User Guide, where you will officially start your development journey in GenAuth!

Here, you will mainly learn two things:

1. Integrated authentication, we will guide you step by step through examples and code on how to quickly integrate authentication functions into your application system;
2. Manage resources, how to manage your resources in GenAuth, such as applications, roles, user directories, configurations, etc.

Before you officially start development, we recommend that you first understand What is GenAuth, and several core concepts in GenAuth: Difference between authentication and authorization, User pool and Application.

¶ Integrate authentication into your application

It is recommended to read Quick Start: Authenticate your first user first, where you will learn the complete steps of integrating GenAuth to help you get started quickly.

After that, you can read the guide by topic:

1. Authenticate users

   • The most basic account and password authentication, mobile phone number verification code authentication means;
   • How to access social login authentication;
   • How to access scan code login authentication;
   • How to authenticate in the mini program;
   • Implement single sign-on (SSO);
   • Implement single sign-on on mobile terminals;
   • How to integrate multi-factor authentication
   • Expand the authentication process:
     • Add user-defined fields
     • Add extended fields to IdToken
     • Use a custom database to authenticate users
     • Use Pipeline to extend the authentication process
     • Use Webhook to listen to authentication events

2. Manage user permissions

   • Choose the right permission model
   • Integrate RBAC permission model into your application system
   • Integrate ABAC Permission model to your application system
   • Use permission groups to manage permission resources
   • Manage resource permissions

3. Authorization

   • User-consented resource authorization
   • Machine-to-machine (M2M) authorization

4. Manage user accounts

   • Understand the meaning of all fields in user profile;
   • Understand how administrators create accounts;
   • Understand how to manage user accounts, such as modifying user profiles, binding MFA, etc.;
   • Learn how to bind an account;
   • ...

5. Detailed guide to Connecting the WeChat Ecosystem Account System.

¶ Manage your resources in GenAuth

It is recommended to read Console Overview first, you will quickly understand what the GenAuth console has, which can help you get a general idea of ​​the GenAuth.

You can then read the guides by topic:

1. Manage User Directory

   • Learn about the configuration items of the user directory;
   • Learn how to add custom user fields;
   • Learn how to search for users;
   • Learn how to use the LDAP user directory.

2. Manage your own application

3. Manage multiple tenants

4. Become a federated identity source

5. Connect to an external identity provider

   • Configure social login
   • Configure a standard protocol identity provider
   • Use a custom database

6. Manage organizations

   • Create or import an organization;
   • Manage organizations;
   • Manage member life cycle;
   • Manage terminal devices;

7. View audit logs

8. Configure security information

   • Configure Web security domain
   • Configure password security

9. Configure user pool information

   • Modify user pool basic information
   • Configure email service and template
   • Configure SMS service

¶ Understand the private deployment solution

If you need to privately deploy GenAuth, please read the following guidelines:

• Basic deployment pattern;
• Docker deployment pattern;
• Kubernetes deployment pattern.