GenAuth DocsDocuments
Concepts
User Guide
Development Integration
AgentAuth
Metadata
Development Integration
Multi-tenant (beta)
Console Documentation
Multi-tenant Console
Tenant Console
Saas Application Demo
Concepts
User Guide
Development Integration
AgentAuth
Metadata
Development Integration
Multi-tenant (beta)
Console Documentation
Multi-tenant Console
Tenant Console
Saas Application Demo
Old version
User Guide
  • Quick Start

  • Authentication

  • Access Control

  • Authorization

  • Adaptive MFA

  • User Account Management

  • User Directory Management

  • Applications

  • Become a Federation Authentication Identity Provider

  • Connect External Identity Providers (IdP)

  • WeChat Ecosystem Full Scenario Capabilities

  • Migrate Users to GenAuth

  • Security Settings

  • Branding

  • Automation

  • Audit Logs

  • Setting

  • FAQ

¶ Add custom user fields

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

User custom fields are additional fields that can be added to user objects in addition to basic user fields. Developers can store a small amount of business-related data by setting custom fields.

¶ Configure custom user fields

You can define the following types of custom fields:

  • String;
  • Numeric;
  • Date;
  • Boolean;
  • Enumeration;

You can configure custom user fields on Settings - Field Management - User Extended Field page:

When naming a newly created custom field, you can edit the display name of the field in multiple language environments:

  • Edit directly in the input box under "Display Name" to get the default displayed field name
  • Check "Chinese" and edit the field display name in the Chinese environment
  • Check "English" and edit the field display name in the English environment
  • Check "Traditional" and edit the field display name in the Traditional Chinese environment
  • Check "Japanese" and edit the field display name in the Japanese environment

In particular, if the display environment of the field is not included in the above four language environments, it will be displayed using the "default displayed field name" you configured.

After configuring custom fields, you can open the registration information completion page of the application and let users complete the information of these custom fields.

On the App Details - Advanced Configuration page, turn on Customize the login box of this application

Then switch to Branding, check the Enable registration information completion switch, and then select the custom field you just added:

Data Type You can choose string, number, Boolean value, enumeration value, date, which will determine the final display style of the page.

Click Save and then visit the login page of the application.

After the user clicks register, he will be redirected to the following registration information completion page:

After the user successfully registers, you can see the custom field value just entered by the user on the user details page:

¶ Use API & SDK to manage user custom data

GenAuth supports SDKs in multiple programming languages including Java, JavaScript/Node.js, Python, PHP, C#, Swift, Go, Ruby, WeChat Mini Program, etc. You can choose the SDK you are familiar with:

  • Java/Kotlin
  • JavaScript/Node.js
  • Python
  • PHP
  • C#
  • Swift
  • Go
  • Ruby
  • WeChat Mini Program
Select language
Java
Loading...

Use the UserPool ID and AppID to initialize the AuthenticationClient of the Java SDK:

import cn.genauth.core.auth.AuthenticationClient;
// Initialize with AppId and appHost
AuthenticationClientOptions options = new AuthenticationClientOptions();
options.setAppId(GEN_AUTH_APP_ID);
options.setAppHost(GEN_AUTH_APP_HOST);
AuthenticationClient client = new AuthenticationClient(options);

First, initialize the SDK with the user's token:

authenticationClient.setAccessToken("ID_TOKEN");

Set custom fields:

List<UserDefinedData> list = authenticationClient.setUdv('school', 'Huazhong University of Science and Technology').execute();

Get the latest custom data of the user:

List<UserDefinedData> list = authenticationClient.listUdv().execute();
  • Configure custom user fields
  • Use API & SDK to manage user custom data

User identity management

Integrated third-party login
Customized authentication process

Enterprise internal management

Single sign-on
Multi-factor authentication
Permission management

Developer

Development Documentation
GitHub (opens new window)

Company

official@genauth.ai
16th Floor, Building B, Beichen Century Center, Chaoyang District, Beijing (Total)
Room 406, 4th Floor, Block B, No. 200, Tianfu Fifth Street, High-tech Zone, Chengdu (Branch)

© Beijing Steamory Technology Co., Ltd.