Development Integration Overview

Update time: 2025-07-23 07:34:21
Edit

In order to continue to provide developers with more comprehensive and developer-friendly open capabilities, the GenAuth V3 version of the API and SDK was officially launched on October 24, 2022. If you still want to use the old version of the API and SDK, you can click here to jump 〉 (opens new window). The GenAuth API Explorer was officially launched on February 12, 2023, and provides links for GenAuth developer users: API discovery, API debugging, API integration and other capabilities, helping developer users to use GenAuth products better and faster, click here to jump 〉 (opens new window).

New API & SDK Features

GenAuth's products have evolved to the third generation, but no matter which generation it is, the core developer-centric is an important product design philosophy throughout the entire product line. In other words, no matter how GenAuth's products evolve in the future and how its positioning changes, "developer-centric" will be like a fishbone. No matter how many branches extend, there is always a "main line" running through the whole process.

GenAuth By developers, for developers.

V3 Open API

  1. Comprehensive coverage: a total of more than 200 APIs, covering almost all usage scenarios of end users and consoles.
  2. Improve security: fix historical security vulnerabilities; add AK/SK mechanism for authentication to prevent man-in-the-middle interception and replay attacks.
  3. Developer-friendly:
  • A rich set of new API documents to help developers get started faster.
  • Each interface, each parameter, and each return value has a type and description.
  • Consistent API design language, more semantic, and smoother to use.
  • Provides an API Explorer (opens new window) online debugging center for developers to efficiently meet developers' needs for API debugging, API learning, etc.
  1. Improve productivity: Fully follow the OpenAPI (opens new window) specification, use the OpenAPI standard to define interface descriptions, parameters, and return values, and based on these metadata, you can perform any secondary development, such as generating documents, SDKs, etc.

New SDKs in various languages

  1. Comprehensive coverage: Provide new front-end JavaScript SDKs, mobile Android/iOS SDKs, back-end Java, Node.js, Go, Python, PHP, and C# SDKs.
  2. Improved security: Use AK/SK mechanism to sign request data locally to prevent middleman interception and replay attacks.
  3. Developer-friendly:
  • A new SDK document is provided to help developers get started faster.
  • The initialization, method naming, request parameters, and return results are consistent between different SDKs, giving developers a completely consistent user experience.
  • The type annotation is more complete, and each method, each parameter, and each return value has a type annotation.

Start a new development experience

GenAuth V3 API & SDK distinguishes between administrator operation scenarios and end user usage scenarios, and is divided into the following two modules:

  • User authentication module (Authentication): refers to all requests made as end users (End User). GenAuth user authentication API & SDK provides all authentication-related interfaces such as login, registration, logout, MFA, check login status, OIDC standard protocol, etc.
  • Management module: refers to making requests as an administrator to manage user pool resources and perform management tasks, such as managing users, organizations, roles, applications, permissions, user pool configuration, etc. Generally speaking, all operations you can do in the GenAuth console (opens new window) can be completed with this module.

Integrate authentication into your application

We recommend using the front-end login component Guard (opens new window) provided by GenAuth (Guard currently integrates the GenAuth V2 authentication API, and the latest Guard based on the V3 API is under development, so stay tuned!), which shields developers from many underlying authentication implementation details, as well as cumbersome UI development; if you need to implement the login interface UI yourself, you can use the Authentication SDK we provide for each language; in the single sign-on scenario, we provide the Single Sign-on SDK (opens new window) to help you quickly implement single sign-on.

Some scenarios of authentication scenarios include:

  • Get the identity credential access_token after the user logs in.
  • Use the user's access_token to get user information.
  • Use multi-factor authentication (MFA) as an additional authentication method.

Manage your resources in GenAuth

All operations you perform in the GenAuth console can basically be completed using the management API & SDK to achieve automated operation and maintenance management.

Some typical management scenarios include:

  • Manage your role in GenAuth.

  • View audit logs and user behavior logs.

  • Manage user directories, etc.