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
  • Single Page Web Application

  • Mobile and Client Applications

  • Standard Web Application

    • Java

      • Installation and Usage
      • User Authentication Module
      • Management Module

        • User Management

          • Get User Information
          • Batch Get User Information
          • Get User List
          • 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 Group List
          • Delete Users
          • Get User MFA Binding Information
          • Get Archived User List
          • Force User Logout
          • Check if User Exists
          • Create User
          • Batch Create Users
          • Update User Profile
          • Get User Accessible Applications
          • Get User Authorized Applications
          • Check if User Has Role
          • Get User Login History
          • Get Applications User Has Logged Into
          • Get Identity Sources User Has Logged Into
          • Get All Resources Authorized to User
        • Group Management

        • Role Management

        • Organization Management

        • Access Control Management

        • External Identity Source Management

        • Custom Field Management

    • Node.js

    • Python

  • Framework Integration

  • Others

  1. Development Integration
  2. /
  3. Standard Web Application
  4. /
  5. Java
  6. /
  7. Management Module

  8. /
  9. User Management

  10. /
  11. Update User Profile

¶ 修改用户资料

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

通过用户 ID,修改用户资料,邮箱、手机号、用户名、externalId 用户池内唯一,此接口将以管理员身份修改用户资料因此不需要进行手机号验证码检验等安全检测。

¶ 请求参数

名称类型必填默认值描述示例值
userIdstring是-用户 ID。6229ffaxxxxxxxxcade3e3d9
phoneCountryCodestring否-手机区号。+86
namestring否-用户真实名称,不具备唯一性。张三
nicknamestring否-昵称。张三
photostring否-头像链接。https://files.authing.co/authing-console/default-user-avatar.png
externalIdstring否-第三方外部 ID。10010
statusstring否Activated账户当前状态。 枚举值:Suspended,Resigned,Activated,ArchivedActivated
emailVerifiedboolean否-邮箱是否验证。true
phoneVerifiedboolean否-手机号是否验证。true
birthdatestring否-出生日期。2022-06-03
countrystring否-所在国家。CN
provincestring否-所在省份。BJ
citystring否-所在城市。BJ
addressstring否-所处地址。北京朝阳
streetAddressstring否-所处街道地址。北京朝阳区 xxx 街道
postalCodestring否-邮政编码号。438100
genderstring否U性别。 枚举值:M,W,UM
usernamestring否-用户名,用户池内唯一。bob
passwordEncryptTypestring否none密码加密类型,支持 sm2 和 rsa。 枚举值:sm2,rsa,nonenone
emailstring否-邮箱。test@example.com
phonestring否-手机号。188xxxx8888
passwordstring否-密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=
customDataobject否-自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。{"school":"北京大学","age":22}
optionsUpdateUserOptionsDto否-可选参数。

¶ 示例代码

import cn.authing.sdk.java.dto.*;
import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.model.ManagementClientOptions;

class ManagementClientTest {
    private static String ACCESS_KEY_ID = "GEN_AUTH_USERPOOL_ID";
    private static String ACCESS_KEY_SECRET = "GEN_AUTH_USERPOOL_SECRET";

    public static void main(String[] args) {
        ManagementClientOptions clientOptions = new ManagementClientOptions(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
        ManagementClient managementClient = new ManagementClient(clientOptions);

        UpdateUserReqDto request = new UpdateUserReqDto();
        request.setUserId("6229ffaxxxxxxxxcade3e3d9");
        request.setPhoneCountryCode("+86");
        request.setName("张三");
        request.setNickname("张三");
        request.setPhoto("https://files.authing.co/authing-console/default-user-avatar.png");
        request.setExternalId("10010");
        request.setStatus(UpdateUserReqDto.status.ACTIVATED);
        request.setEmailVerified(true);
        request.setPhoneVerified(true);
        request.setBirthdate("2022-06-03");
        request.setCountry("CN");
        request.setProvince("BJ");
        request.setCity("BJ");
        request.setAddress("北京朝阳");
        request.setStreetAddress("北京朝阳区 xxx 街道");
        request.setPostalCode("438100");
        request.setGender(UpdateUserReqDto.gender.M);
        request.setUsername("bob");
        request.setPasswordEncryptType(UpdateUserReqDto.passwordEncryptType.NONE);
        request.setEmail("test@example.com");
        request.setPhone("188xxxx8888");
        request.setPassword("oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=");
        request.setCustomData(new UpdateUserReqDto.setSchool("北京大学",.setAge(age22,));
            Options= new UpdateUserOptionsDto(
                    request.setUserIdType(UpdateUserOptionsDto.userIdType.USER_ID);
    request.setResetPasswordOnNextLogin(false);
    request.setAutoGeneratePassword(false);
        SendPasswordResetedNotification= new SendResetPasswordNotificationDto(
                    request.setSendDefaultEmailNotification(false);
    request.setSendDefaultPhoneNotification(false);
    request.setInputSendEmailNotification("test@example.com");
    request.setInputSendPhoneNotification("183xxxx1234");
    request.setAppId("appid1");
        ),
        ),

        UserSingleRespDto response = managementClient.updateUser(request);
        System.out.println(response);
    }
}

¶ 请求响应

类型: UserSingleRespDto

名称类型描述
statusCodenumber业务状态码,可以通过此状态码判断操作是否成功,200 表示成功。
messagestring描述信息
apiCodenumber细分错误码,可通过此错误码得到具体的错误类型。
dataUserDto响应数据

示例结果:

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "userId": "6229ffaxxxxxxxxcade3e3d9",
    "createdAt": "2022-07-03T02:20:30.000Z",
    "updatedAt": "2022-07-03T02:20:30.000Z",
    "status": "Activated",
    "email": "test@example.com",
    "phone": "188xxxx8888",
    "phoneCountryCode": "+86",
    "username": "bob",
    "name": "张三",
    "nickname": "张三",
    "photo": "https://files.authing.co/authing-console/default-user-avatar.png",
    "loginsCount": 3,
    "lastLogin": "2022-07-03T02:20:30.000Z",
    "lastIp": "127.0.0.1",
    "gender": "M",
    "emailVerified": true,
    "phoneVerified": true,
    "passwordLastSetAt": "2022-07-03T02:20:30.000Z",
    "birthdate": "2022-06-03",
    "country": "CN",
    "province": "BJ",
    "city": "BJ",
    "address": "北京朝阳",
    "streetAddress": "北京朝阳区 xxx 街道",
    "postalCode": "438100",
    "externalId": "10010",
    "departmentIds": "[\"624d930c3xxxx5c08dd4986e\",\"624d93102xxxx012f33cd2fe\"]",
    "identities": {
      "identityId": "62299d8b866d2dab79a89dc4",
      "extIdpId": "6076bacxxxxxxxxd80d993b5",
      "provider": "wechat",
      "type": "openid",
      "userIdInIdp": "oj7Nq05R-RRaqak0_YlMLnnIwsvg",
      "originConnIds": "[\"605492ac41xxxxe0362f0707\"]"
    },
    "customData": {
      "school": "北京大学",
      "age": 22
    },
    "statusChangedAt": "2022-07-03T02:20:30.000Z"
  }
}

¶ 数据结构

¶ UpdateUserOptionsDto

名称类型必填描述
userIdTypestring否用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:user_id,external_id,phone,email,username
resetPasswordOnNextLoginboolean否下次登录要求重置密码。
autoGeneratePasswordboolean否是否自动生成密码。
sendPasswordResetedNotification否重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: [object Object]

¶ SendResetPasswordNotificationDto

名称类型必填描述
sendDefaultEmailNotificationboolean否重置密码之后,是否发送用户默认邮件通知。
sendDefaultPhoneNotificationboolean否重置密码之后,是否发送用户默认短信通知。
inputSendEmailNotificationstring否当用户密码修改之后,输入发送邮箱。 示例值: test@example.com
inputSendPhoneNotificationstring否当用户密码修改之后,输入发送手机号。 示例值: 183xxxx1234
appIdstring否发送登录地址时,指定的应用 id,会将此应用的登录地址发送给用户的邮箱或者手机号。默认为用户池应用面板的登录地址。。 示例值: appid1

¶ UserDto

名称类型必填描述
userIdstring是用户 ID。 示例值: 6229ffaxxxxxxxxcade3e3d9
createdAtstring是账号创建时间。 示例值: 2022-07-03T02:20:30.000Z
updatedAtstring是账号更新时间。 示例值: 2022-07-03T02:20:30.000Z
statusstring是账户当前状态。 枚举值:Suspended,Resigned,Activated,Archived
emailstring否邮箱。 示例值: test@example.com
phonestring否手机号。 示例值: 188xxxx8888
phoneCountryCodestring否手机区号。 示例值: +86
usernamestring否用户名,用户池内唯一。 示例值: bob
namestring否用户真实名称,不具备唯一性。 示例值: 张三
nicknamestring否昵称。 示例值: 张三
photostring否头像链接。 示例值: https://files.authing.co/authing-console/default-user-avatar.png
loginsCountnumber否历史总登录次数。 示例值: 3
lastLoginstring否上次登录时间。 示例值: 2022-07-03T02:20:30.000Z
lastIpstring否上次登录 IP。 示例值: 127.0.0.1
genderstring是性别。 枚举值:M,W,U
emailVerifiedboolean是邮箱是否验证。 示例值: true
phoneVerifiedboolean是手机号是否验证。 示例值: true
passwordLastSetAtstring否用户上次密码修改时间。 示例值: 2022-07-03T02:20:30.000Z
birthdatestring否出生日期。 示例值: 2022-06-03
countrystring否所在国家。 示例值: CN
provincestring否所在省份。 示例值: BJ
citystring否所在城市。 示例值: BJ
addressstring否所处地址。 示例值: 北京朝阳
streetAddressstring否所处街道地址。 示例值: 北京朝阳区 xxx 街道
postalCodestring否邮政编码号。 示例值: 438100
externalIdstring否第三方外部 ID。 示例值: 10010
resetPasswordOnNextLoginboolean否下次登录要求重置密码。
departmentIdsarray否用户所属部门 ID 列表。 示例值: ["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]
identitiesarray否外部身份源。嵌套类型:IdentityDto。
customDataobject否用户的扩展字段数据。 示例值: [object Object]
statusChangedAtstring否用户状态上次修改时间。 示例值: 2022-07-03T02:20:30.000Z

¶ IdentityDto

名称类型必填描述
identityIdstring是Identity ID。 示例值: 62299d8b866d2dab79a89dc4
extIdpIdstring是外部身份源的 ID。 示例值: 6076bacxxxxxxxxd80d993b5
providerstring是外部身份源类型,如 lark, wechat。 示例值: wechat
typestring是Identity 类型,如 unionid, openid, primary。 示例值: openid
userIdInIdpstring是在外部身份源的 id。 示例值: oj7Nq05R-RRaqak0_YlMLnnIwsvg
originConnIdsarray是身份来自的身份源连接 ID 列表。 示例值: ["605492ac41xxxxe0362f0707"]
Previous article: Batch Create Users Next article: Get User Accessible Applications
  • 请求参数
  • 示例代码
  • 请求响应
  • 数据结构

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.