Skip to content

Steamory Agent Kit

Main Navigation GenAuth GUM Web Agent

English

English

Appearance

Sidebar Navigation

GenAuth

Overview

Concepts

What is GenAuth

What is User Pool

What is Application

What is Authentication

What is Federation Authentication

What is Zero Trust Network

Single Sign-On and Single Sign-Out

What is Authorization

Authentication vs Authorization

What is JWT Token

What is ID Token

What is Access Token

What is Refresh Token

Access Token vs Id Token

Understanding OIDC and OAuth2.0 Protocol

OIDC and OAuth2.0 Overview

Choose OIDC Authorization Mode

OIDC Common Questions

Understanding SAML2 Protocol

SAML2 Overview

SAML2 Flow

What is Multi-Factor Authentication

Account Lifecycle Management

Hosted Login Page vs Embeddable Login Component

CIAM and EIAM

What is LDAP

How QR Code Login Works

Basic Concepts of Cryptography

Guides

Quick Start

Authenticate Your First User

Overview

Use Hosted Login Page

Use Embedded Login Component

Use API & SDK

Validate User Token

Implement Access Control

Logout

What's Next

Integration Methods for Different Applications

Integrate GenAuth with Regular Web Apps

Integrate GenAuth with Single Page Apps

Integrate GenAuth with Mobile Apps

Trial Period

Admin Operations

End User Operations

Console Overview

Authentication

Overview

Username Password Authentication

SMS Code Authentication

Social Login Authentication

QR Code Login

Use Self-built App for QR Code Login

Overview

Complete API List

Custom Settings

Use WeChat Mini Program for QR Code Login

Authentication in Mini Programs

One-click Mobile Login

Implement Single Sign-On (SSO)

Mobile SSO

Multi-factor Authentication

Extend Authentication Process

Add Custom User Fields

Add Custom Role Fields

Add Custom Fields to IdToken

Use Custom Database for Authentication

Extend Authentication Process with Pipeline

Monitor Authentication Events with Webhook

Customize Login UI

Access Control

Choose the Right Access Control Model

Integrate RBAC Model

Integrate ABAC Model

Use Permission Groups

Manage Resource Permissions

Manage New Data Resource Permissions

Permission Space

Role Management

Data Resources

Data Policies and Authorization

Data Policies and OPA

Permission View

Authorization

User Consent Authorization

Machine-to-Machine (M2M) Authorization

Adaptive MFA

GenAuth CAMFA Overview

Integrate GenAuth Guard for Continuous Adaptive MFA

Integrate Existing IAM/IDaaS/Auth Systems with GenAuth Adaptive MFA

Advanced MFA: Continuous Adaptive Multi-Factor Authentication (CAMFA) Guide

Adaptive MFA Orchestration/Policy Configuration Guide

User Account Management

User Field Definitions

Admin Create Account

Manage User Accounts

Link Accounts

Manage User Custom Data

View Login History

View User Geolocation

Enhance Account Security

Manage Login Sessions

Control Application Access

User Group Management

Invitation Management

User Directory Management

User Directory Settings

Add Custom User Fields

Search Users

Use LDAP User Directory

Applications

Self-built Applications

Create Self-built Application

Quick Start

Application Configuration

Protocol Configuration

Configure OIDC Protocol

Custom OIDC Scope

Configure OAuth Protocol

Configure SAML Protocol

Configure CAS Protocol

Login Control

Access Authorization

Branding

Security Management

Advanced Settings

Tenant Configuration

Single Sign-On SSO

Application Panel

Integration Application SSO Solutions

Self-built Application SSO Solutions

Third-party SSO Solutions

Lark Workspace SSO Solution

WeCom SSO Solution

DingTalk SSO Solution

WeLink SSO Solution

ASA Form Fill

ASAD Form Fill

Gateway Form Fill

Become a Federation Authentication Identity Provider

Become an OpenID Connect Identity Provider

Become an OAuth2.0 Identity Provider

Become a SAML2 Identity Provider

Become a CAS Identity Provider

Connect External Identity Providers (IdP)

Social Identity Providers

WeChat PC QR Code

WeChat PC Mini Program QR Code

WeChat Official Account Follow

WeChat Mobile

APP Launch WeChat Mini Program

Huawei

Huawei Mobile

Honor

Xiaomi

Xiaomi Mobile

Tencent QQ

Tencent QQ Mobile

Sina Weibo

Sina Weibo Mobile

Douyin Mobile

Kuaishou Mobile

GitHub

GitHub Mobile

Facebook

Facebook Mobile

Twitter

Twitter Mobile

Google Web

Google Mobile

Apple Mobile

Apple Web

AWS

Alipay

Slack

Slack Mobile

Gitee

Gitee Mobile

GitLab

GitLab Mobile

Baidu

Baidu Mobile

Yidun (One-click Login)

QingCloud

Instagram

LinkedIn

LinkedIn Mobile

Line Mobile

Amazon

Amazon Mobile

OPPO Mobile

Custom Database

Configure Database Connection and Write Scripts

Lazy Migration of Users to GenAuth

Fully Use Custom Database to Store User Data

Best Practices

Account Binding

WeChat Ecosystem Full Scenario Capabilities

When Developing with WeChat Mobile Apps

When Developing with WeChat Web Apps

When Developing with WeChat Official Accounts

When Developing with WeChat Mini Programs

Migrate Users to GenAuth

Import Users Using SDK

Custom Password Encryption Method

Manage Organizations

Create or Import Organizations

Manage Organizations

Manage Member Lifecycle

Manage End Devices

Security Settings

General Security

Configure Web Security Domain

Configure Registration Rate Limit

Configure Login Failure Limit

Password Security

Password Policy

Custom Password Encryption Method

Multi-factor Authentication

SMS Code Based MFA

Email Code Based MFA

Time-based One-time Password MFA

Face Recognition Based MFA

Integrate MFA via SDK

MFA Policy Configuration

Branding

Global Login Box

Message Settings

Configure Email Service and Templates

Configure SMS Service and Templates

Custom Domain

Application Panel

Automation

Pipeline

Create Your First Pipeline Function

Pipeline API Reference

Pipeline Use Cases

Pipeline User Object

Pipeline Context Object

Use Environment Variables in Pipeline

Available Node Modules

How to Debug

Private Deployment

Webhooks

Audit Logs

User Action Audit

Administrator Action Audit

设置

基础设置

字段管理

用户字段管理

用户基础字段

用户拓展字段

角色字段管理

开发者

管理员

管理员权限（新）

GenAuth 令牌

私有化部署方案

基础部署模式

Docker 部署模式

Kubernetes 部署模式

常见问题 FAQ

如何获取用户池 ID

如何获取应用 ID

如何验证用户身份凭证（token）

使用统一域名的用户池

如何识别用户来源

在本地联表 GenAuth 用户与你的业务数据

禁用第三方 Cookie 对 GenAuth 的影响

如何部署中转代理服务器

如何获取 GenAuth 服务器集群 IP

Pipeline 常见问题

Reference

Node.js

Installation and Usage

Authentication Module

Login

Sign in with Account Password

Sign in with Username Password

Sign in with Phone Password

Sign in with Email Password

Sign in with Email Passcode

Sign in with Phone Passcode

Sign in with LDAP Account

Sign in with AD Account

Generate Login URL

Sign in with User Credentials

Sign in with Mobile Social Login

Get Alipay AuthInfo

Generate QR Code for Login

Check QR Code Status

Exchange TokenSet with QR Code Ticket

Custom APP QR Code Login: Change QR Code Status on APP Side

Logout

Frontend Logout

Backend Logout

Token Management

Get Token

Validate Token

Revoke Token

Registration

Register with Username Password

Register with Email Password

Register with Phone Passcode

Register with Email Passcode

Register

User Profile

Get User Profile

Update User Profile

Bind Email

Unbind Email

Bind Phone

Unbind Phone

Get Password Strength and Account Security Score

Update Password

Initiate Email Update Verification Request

Update Email

Initiate Phone Update Verification Request

Update Phone

Initiate Forgot Password Request

Reset Password

Initiate Account Deletion Request

Delete Account

Account Binding

Generate External Identity Source Binding Link

Unbind External Identity Source

Get Bound External Identity Sources

Get Application Enabled External Identity Sources List

MFA Factor Management

Initiate MFA Factor Binding Request

Bind MFA Factor

Unbind MFA Factor

Get All Bound MFA Factors

Get Specific Bound MFA Factor

Get Available MFA Factors for Binding

User Related Resources

Get Login History

Get Login Applications

Get Accessible Applications

Get Tenant List

Get Role List

Get Group List

Get Department List

Get Authorized Resources List

Message Service

Send SMS

Send Email

Authorization

String Resource Authorization

Array Resource Authorization

Tree Resource Authorization

Get User Authorized Resources List in Login Application

Get User Resource Permissions List in Login Application

Get User Resource Permissions Structure in Login Application

WeChat Related APIs

Decrypt WeChat Mini Program Data

Get WeChat Mini Program and Official Account Access Token

Others

Get Server Public Information

Get Country List

OIDC Module

OAuth Module

SAML Module

CAS Module

Events

Management Module

User Management

Get User List

Get User Information

Batch Get User Information

Create User

Batch Create Users

Update User Profile

Batch Update User Profile

Delete Users

Get User External Identity Sources

Get User Role List

Get User Real-name Authentication Information

Delete User Real-name Authentication Information

Get User Department List

Set User Departments

Get User Group List

Get User MFA Binding Information

Get Archived User List

Force Logout Users

Check if User Exists

Get User Accessible Applications

Get User Authorized Applications

Check if User Has Role

Get User Login History

Get User Previously Logged In Applications

Get User Previously Logged In Identity Sources

User Resignation

Batch User Resignation

Get User Authorized Resources

Check User Session Status in Application

Import User OTP

Set User MFA Status

Get User MFA Status

Organization Management

Get Organization Details

Batch Get Organization Details

Get Organization List

Create Organization

Update Organization

Delete Organization

Search Organizations

Get Department Information

Create Department

Update Department

Delete Department

Search Departments

Get Child Department List

Get Department Member List

Get Department Direct Member ID List

Search Department Members

Add Department Members

Remove Department Members

Get Parent Department Information

Check if User is in Department

Role Management

Get Role Details

Assign Role

Revoke Role

Get Role Authorized Resources

Get Role Member List

Get Role Department List

Create Role

Get Role List

Delete Roles

Batch Create Roles

Update Role

User Group Management

Get Group Details

Get Group List

Create Group

Batch Create Groups

Update Group

Batch Delete Groups

Add Group Members

Batch Remove Group Members

Get Group Member List

Get Group Authorized Resources

Custom Field Management

Get User Built-in Fields List

Update User Built-in Fields Configuration

Get Custom Fields List

Create/Update Custom Field Definition

Set Custom Field Value

Get Custom Field Values for User, Group, Role, Organization

Resource and Permission Management

Create Resource

Batch Create Resources

Get Resource Details

Batch Get Resource Details

Get Resource List with Pagination

Update Resource

Delete Resource

Batch Delete Resources

Associate/Disassociate Application Resources to Tenant

Create Permission Group

Batch Create Permission Groups

Get Permission Group Details

Batch Get Permission Group Details

Update Permission Group Information

Delete Permission Group Information

Batch Delete Permission Groups

Authorize Resources

Get List of Authorized Resources for a Subject

Check if User Has Permission for Resource Action

Get Authorized Subjects for Resource

Manage Data Resources and Permissions

Create Permission Namespace

Batch Create Permission Namespaces

Get Permission Namespace Details

Batch Get Permission Namespace Details List

Get Paginated Permission Namespace List

Update Permission Namespace

Delete Permission Namespace

Batch Delete Permission Namespaces

Check if Permission Namespace Code or Name is Available

Get Paginated Role List Under Permission Namespace

Create Data Resource

Create String Data Resource

Create Array Data Resource

Create Tree Data Resource

Get Data Resource List

Get Data Resource Information

Update Data Resource

Delete Data Resource

Check if Data Resource Name or Code is Available

Create Data Policy

Get Data Policy List

Get Simple Data Policy List

Get Data Policy Information

Update Data Policy

Delete Data Policy

Check if Data Policy Name Exists

Get All Authorized Subjects Information Under Data Policy

Authorize Data Policies

Revoke Data Policy

Get User Permission List

Check User Permission

Check External User Permission

Get User Specific Resource Permission List

Get List of Users Authorized for Resource

Get User Authorized Resource Structure List

Get External User Authorized Resource Structure List

Check User Permission for Same Level Resources in Tree Resource

Manage Applications

Get Application Details

Get Application List

Get Application Basic Information

Get Application Basic Information List

Create Application

Delete Application

Get Application Secret

Refresh Application Secret

Get Current Active Users of Application

Get Application Default Access Authorization Strategy

Update Application Default Access Authorization Strategy

Authorize Application Access

Delete Application Access Authorization Record

Check Domain Availability

Get Application User MFA Trigger Data

Manage Identity Sources

Get Identity Source List

Get Identity Source Details

Create Identity Source

Update Identity Source Configuration

Delete Identity Source

Create New Connection Under Existing Identity Source

Update Identity Source Connection

Delete Identity Source Connection

Identity Source Connection Switch

Tenant Associate Identity Source

Get Identity Source List in Tenant Console

Application Connection Details Under Identity Source

Manage Security Configuration

Get Security Configuration

Update Security Configuration

Get Global MFA Configuration

Update Global MFA Configuration

Manage Message Service

Get Email Template List

Update Email Template

Preview Email Template

Get Third-party Email Service Configuration

Configure Third-party Email Service

Manage Pipeline

Create Pipeline Function

Get Pipeline Function Details

Re-upload Pipeline Function

Update Pipeline Function

Update Pipeline Function Order

Delete Pipeline Function

Get Pipeline Function List

Get Pipeline Logs

Manage Webhook

Create Webhook

Get Webhook List

Update Webhook Configuration

Delete Webhook

Get Webhook Logs

Manually Trigger Webhook Execution

Get Webhook Details

Get Webhook Event List

Get Audit Logs

Get User Action Logs

Get Admin Operation Logs

Manage Metering and Billing

Get Package Details

Get Usage Details

Get MAU Usage Records

Get All Rights Items

Get Order List

Get Order Details

Get Order Payment Details

Events

Python

Installation and Usage

Authentication Module

Login

Login with Account Password

Login with Username Password

Login with Phone Password

Login with Email Password

Login with Email Passcode

Login with Phone Passcode

Login with LDAP Account

Login with AD Account

Login with User Credentials

Login with Mobile Social Login

Get Alipay AuthInfo

Generate QR Code for Login

Check QR Code Status

Exchange TokenSet with QR Code Ticket

Custom APP QR Code Login: Change QR Code Status on APP Side

Logout

Frontend Logout

Backend Logout

Register

Register with Username Password

Register with Email Password

Register with Phone Passcode

Register with Email Passcode

Register

User Profile

Get User Profile

Update User Profile

Bind Email

Unbind Email

Bind Phone

Unbind Phone

Get Password Strength and Account Security Score

Update Password

Initiate Email Update Verification Request

Update Email

Initiate Phone Update Verification Request

Update Phone

Initiate Reset Password Request

Reset Password

Initiate Account Deletion Request

Delete Account

Account Binding

Generate External Identity Provider Link

Unbind External Identity Provider

Get Bound External Identity Providers

Get Application Enabled External Identity Providers

MFA Factor Management

Initiate MFA Factor Enrollment Request

Enroll MFA Factor

Reset MFA Factor

Get All Enrolled MFA Factors

Get Specific Enrolled MFA Factor

Get Available MFA Factors

User Related Resources

Get Login History

Get Logged In Applications

Get Accessible Applications

Get Tenant List

Get Role List

Get Group List

Get Department List

Get Authorized Resource List

Message Service

Send SMS

Send Email

WeChat Related APIs

Decrypt WeChat Mini Program Data

Get Mini Program Phone Number

Get GenAuth Server Cached WeChat Mini Program/Official Account Access Token

Others

Get Server Public Information

Get Country List

OIDC Module

OAuth Module

SAML Module

CAS Module

Events

Management Module

User Management

Get User List

Get User Information

Batch Get User Information

Create User

Batch Create Users

Update User Profile

Batch Update User Profile

Delete Users

Get User External Identity Sources

Get User Role List

Get User Real-name Authentication Info

Delete User Real-name Authentication Info

Get User Department List

Set User Departments

Get User Group List

Get User MFA Binding Info

Get Archived User List

Force Logout Users

Check if User Exists

Get User Accessible Apps

Get User Authorized Apps

Check if User Has Role

Get User Login History

Get User Previously Logged In Apps

Get User Previously Logged In Identity Sources

User Resignation

Batch User Resignation

Get User Authorized Resources

Check User Session Status in Application

Import User OTP

Organization Management

Get Organization Details

Batch Get Organization Details

Get Organization List

Create Organization

Update Organization

Delete Organization

Search Organization List

Get Department Info

Create Department

Update Department

Delete Department

Search Departments

Get Child Department List

Get Department Member List

Get Department Direct Member ID List

Search Department Members

Add Department Members

Remove Department Members

Get Parent Department Info

Check if User is in Department

Role Management

Get Role Details

Assign Role

Revoke Role

Get Role Authorized Resources

Get Role Member List

Get Role Department List

Create Role

Get Role List

Delete Roles

Batch Create Roles

Update Role

User Group Management

Get Group Details

Get Group List

Create Group

Batch Create Groups

Update Group

Batch Delete Groups

Add Group Members

Batch Remove Group Members

Get Group Member List

Get Group Authorized Resources

Custom Field Management

Get User Built-in Field List

Update User Built-in Field Configuration

Get Custom Field List

Create/Update Custom Field Definition

Set Custom Field Value

Get Custom Field Values for User/Group/Role/Organization

Resource and Permission Management

Create Resource

Batch Create Resources

Get Resource Details

Batch Get Resource Details

Get Resource List by Page

Update Resource

Delete Resource

Batch Delete Resources

Associate/Disassociate Application Resources to Tenant

Create Permission Namespace

Batch Create Permission Namespaces

Get Permission Namespace Details

Batch Get Permission Namespace Details

Update Permission Namespace

Delete Permission Namespace

Batch Delete Permission Namespaces

Authorize Resources

Get Authorized Resource List for Principal

Check if User Has Permission for Resource Action

Get Authorized Principals for Resource

管理应用

获取应用详情

获取应用列表

获取应用简单信息

获取应用简单信息列表

创建应用

删除应用

获取应用密钥

刷新应用密钥

获取应用当前登录用户

获取应用默认访问授权策略

更新应用默认访问授权策略

授权应用访问权限

删除应用访问授权记录

检测域名是否可用

管理身份源

获取身份源列表

获取身份源详情

创建身份源

更新身份源配置

删除身份源

在某个已有身份源下创建新连接

更新身份源连接

删除身份源连接

身份源连接开关

租户关联身份源

租户控制台获取身份源列表

身份源下应用的连接详情

管理安全配置

获取安全配置

修改安全配置

获取全局多因素认证配置

修改全局多因素认证配置

管理消息服务

获取邮件模版列表

修改邮件模版

预览邮件模版

获取第三方邮件服务配置

配置第三方邮件服务

管理 Pipeline

创建 Pipeline 函数

获取 Pipeline 函数详情

重新上传 Pipeline 函数

修改 Pipeline 函数

修改 Pipeline 函数顺序

删除 Pipeline 函数

获取 Pipeline 函数列表

获取 Pipeline 日志

管理 Webhook

创建 Webhook

获取 Webhook 列表

修改 Webhook 配置

删除 Webhook

获取 Webhook 日志

手动触发 Webhook 执行

获取 Webhook 详情

获取 Webhook 事件列表

获取审计日志

获取用户行为日志

获取管理员操作日志

管理计量计费

获取套餐详情

获取用量详情

获取 MAU 使用记录

获取所有权益

获取订单列表

获取订单详情

获取订单支付明细

事件

On this page

Use QR code scanning to log in

Use self-built App to scan QR code to log in to the website
Use mini program to scan QR code to log in to the website

Pager

Previous pageSocial Login Authentication

Next pageUse Self-built App for QR Code Login

Agent infrastructure for identity, memory, and web action.

Steamory Agent Kit