Modify user information in batches

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.

Modify user information in batches, email, mobile number, user name, externalId is unique in the user pool, this interface will modify user information as an administrator, so there is no need to perform security checks such as mobile number verification code verification.

Method name

ManagementClient.updateUserBatch

Request parameters

| Name | Type | Required | Default value | Description | Sample value | | ------- | ------------------------------------------------------------------ | -------------------------------------- | ------------------------------------ | ----------------------------------- | ------------------------------ ... [{"userId":"63f867961cxxxx41e7ccb582","status":"Activated","email":"test@example.com","username":"bob","name":"xxxx","nickname":"xxxx","password":"passw0rd","photo":"https://files.authing.co/authing-console/default-user-avatar.png","gender":"M","birthdate":"2022-06-03","country":"CN","province":"BJ","city":"BJ","address":"xxxxxxx","streetAddress":"xxx street","postalCode":"438100","company":"steamory","browser":"Mozilla/5.0 (Linux; Android 10; V2001A; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/87.0.4280.141 Mobile Safari/537.36 VivoBrowser/10.2.10.0","device":"iOS","givenName":"xx","familyName":"xx","middleName":"James","profile":"alice","pr eferredUsername":"alice","website":"https://my-website.com","zoneinfo":"GMT-08:00","locale":"af","formatted":"132, My Street, Kingston, New York 12401.","region":"Xinjiang Uyghur Autonomous Region"}] | | options | <a UpdateUserBatchOptionsDto | No | - | Optional parameters | {"autoGeneratePassword":true,"resetPasswordOnFirstLogin":true,"passwordEncryptType":"none"} |

Request Response

Type: UserListRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	array	user list

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "userId": "6229ffaxxxxxxxxcade3e3d9",
    "createdAt": "2022-07-03T03:20:30.000Z",
    "updatedAt": "2022-07-03T03:20:30.000Z",
    "status": "Activated",
    "workStatus": "Active",
    "externalId": "10010",
    "email": "test@example.com",
    "phone": "188xxxx8888",
    "phoneCountryCode": "+86",
    "username": "bob",
    "name": "xxxx",
    "nickname": "xxxx",
    "photo": "https://files.authing.co/authing-console/default-user-avatar.png",
    "loginsCount": 3,
    "lastLogin": "2022-07-03T03:20:30.000Z",
    "lastIp": "127.0.0.1",
    "gender": "M",
    "emailVerified": true,
    "phoneVerified": true,
    "passwordLastSetAt": "2022-07-03T03:20:30.000Z",
    "birthdate": "2022-06-03",
    "country": "CN",
    "province": "BJ",
    "city": "BJ",
    "address": "xxxxxxx",
    "streetAddress": "Beijing Chaoyang District xxx Street",
    "postalCode": "438100",
    "company": "steamory",
    "browser": "Mozilla/5.0 (Linux; Android 10; V2001A; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/87.0.4280.141 Mobile Safari/537.36 VivoBrowser/10.2.10.0",
    "device": "iOS",
    "givenName": "xx",
    "familyName": "xx",
    "middleName": "James",
    "profile": "alice",
    "preferredUsername": "alice",
    "website": "https://my-website.com",
    "zoneinfo": "GMT-08:00",
    "locale": "af",
    "formatted": "132, My Street, Kingston, New York 12401.",
    "region": "Xinjiang Uyghur Autonomous Region",
    "userSourceType": "register",
    "passwordSecurityLevel": 1,
    "departmentIds": "[\"624d930c3xxxx5c08dd4986e\",\"624d93102xxxx012f33cd2fe\"]",
    "identities": {
      "identityId": "62299d8b866d2dab79a89dc4",
      "extIdpId": "6076bacxxxxxxxxd80d993b5",
      "provider": "wechat",
      "type": "openid",
      "userIdInIdp": "oj7Nq05R-RRaqak0_YlMLnnIwsvg",
      "accessToken": "57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx",
      "refreshToken": "57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx",
      "originConnIds": "[\"605492ac41xxxxe0362f0707\"]"
    },
    "identityNumber": "420421xxxxxxxx1234",
    "customData": {
      "school": "Peking University",
      "age": 22
    },
    "statusChangedAt": "2022-07-03T03:20:30.000Z"
  }
}

Data structure

UpdateUserInfoDto

Name	Type	Is it required?	Description	Sample value
userId	string	Yes	The unique identifier of the user, which can be user ID, user name, email address, mobile phone number, externalId, ID in external identity source, detailsSee the description of the userIdType field. The default is user id.	6229ffaxxxxxxxxcade3e3d9
phoneCountryCode	string	No	Mobile phone area code. This field is optional for mainland China mobile phone numbers. The GenAuth SMS service does not yet support international mobile phone numbers. You need to configure the corresponding international SMS service in the GenAuth console. For a complete list of mobile phone area codes, see https://en.wikipedia.org/wiki/List_of_country_calling_codes.	+86
name	string	No	User's real name, not unique	Zhang San
nickname	string	No	Nickname	Zhang San
photo	string	No	Avatar link	https://files.authing.co/authing-console/default-user-avatar.png
externalId	string	No	Third-party external ID	10010
status	string	No	Current account status	Suspended
emailVerified	boolean	No	Email verified	true
phoneVerified	boolean	No	Phone number verified	true
birthdate	string	No	Date of birth	2022-06-03
country	string	No	Country	CN
province	string	No	Province	BJ
city	string	No	City	BJ
address	string	No	Address	Beijing Chaoyang
streetAddress	string	No	Street address	Beijing Chaoyang District xxx Street
postalCode	string	No	Postal code	438100
gender	string	No	Gender	M
username	string	No	Username, unique in the user pool	bob
email	string	No	Email, case-insensitive	test@example.com
phone	string	No	Phone number, without area code. If it is a foreign phone number, please specify the area code in the phoneCountryCode parameter.	188xxxx8888
password	string	No	User password, in plain text by default. We use the HTTPS protocol to securely transmit passwords, which can ensure security to a certain extent. If you need a higher level of security, we also support RSA256 and SM2 encryption for passwords. See the passwordEncryptType parameter for details.	passw0rd
company	string	No	Company	steamory
browser	string	No	The browser used when you last logged in UA	Mozilla/5.0 (Linux; Android 10; V2001A; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/87.0.4280.141 Mobile Safari/537.36 VivoBrowser/10.2.10.0
device	string	No	The device used when you last logged in	iOS
givenName	string	no	first name	xx
familyName	string	no	last name	xx
middleName	string	no	middle name	James
profile	string	no	Preferred Username	alice
preferredUsername	string	no	Preferred Username	alice
website	string	no	User personal website	https://my-website.com
zoneinfo	string	no	User time zone information	GMT-08:00
locale	string	no	Locale	af
formatted	string	no	Full standard address	132, My Street, Kingston, New York 12401.
region	string	no	User location	Xinjiang Uyghur Autonomous Region
identityNumber	string	no	User ID number	420421xxxxxxxx1234
customData	object	No	Custom data. The key in the passed object must first be defined in the user pool.	{"school":"Peking University","age":22}
metadata	object	No	Data object data. The key in the passed object must first be defined in the user data object.	{"school":"Peking University","age":22}

UpdateUserBatchOptionsDto

Name	Type	Is it required?	Description	Sample value
resetPasswordOnNextLogin	boolean	No	Require password reset on next login
passwordEncryptType	string	No	Password encryption type, supports RSA256 and SM2 algorithms. The default is none, no encryption. - none: Do not encrypt the password, use plain text for transmission. - rsa: Use RSA256 algorithm to encrypt the password, and need to use the RSA public key of GenAuth service for encryption. Please read the Introduction section to learn how to obtain the RSA256 public key of GenAuth service. - sm2: Use SM2 algorithm to encrypt the password, and need to use the SM2 public key of GenAuth service for encryption. Please read the Introduction section to learn how to obtain the SM2 public key of GenAuth service.	sm2
autoGeneratePassword	boolean	No	Whether to automatically generate a password
sendPasswordResetedNotification		No	Options for sending email and phone number when resetting password Nested type: <a SendResetPasswordNotificationDto.	{"sendDefaultEmailNotification":false,"sendDefaultPhoneNotification":false,"inputSendEmailNotification":"test@example.com","inputSendPhoneNotification":"136xxxx1234","appId":"app1"}

SendResetPasswordNotificationDto

Name	Type	Is it required?	Description	Sample value
sendDefaultEmailNotification	boolean	No	After resetting the password, whether to send the user's default email notification
sendDefaultPhoneNotification	boolean	No	After resetting the password, whether to send the user's default SMS notification
inputSendEmailNotification	string	No	When the user's password is changed, enter the email address to send	test@example.com
inputSendPhoneNotification	string	No	When the user's password is changed, enter the mobile phone number to send	183xxxx1234
appId	string	No	When sending the login address, the specified application id will send the login address of this application to the user's email or mobile phone number. The default is the login address of the user pool application panel.	appid1

UserDto

Name	Type	Required	Description	Sample value
userId	string	Yes	The unique identifier of the user, which can be user ID, user name, email address, mobile phone number, externalId, or ID in an external identity source. For details, see the description of the userIdType field. The default is user id.	6229ffaxxxxxxxxcade3e3d9
createdAt	string	yes	creation time	2022-07-03T03:20:30.000Z
updatedAt	string	yes	update time	2022-07-03T03:20:30.000Z
status	string	yes	current status of the account: - Activated: normal status - Suspended: deactivated - Deactivated: disabled - Resigned: resigned - Archived: archived	Suspended
workStatus	string	yes	current work status of the account	Closed
externalId	string	no	third-party external ID	10010
email	string	No	Email address, case insensitive	test@example.com
phone	string	No	Phone number without area code. If it is an international phone number, please specify the area code in the phoneCountryCode parameter.	188xxxx8888
phoneCountryCode	string	No	Phone area code. This parameter is optional for phone numbers in mainland China. The GenAuth SMS service does not currently support international phone numbers. You need to configure the corresponding international SMS service in the GenAuth console. For a complete list of phone area codes, please refer to https://en.wikipedia.org/wiki/List_of_country_calling_codes.	+86
username	string	No	Username, unique in the user pool	bob
name	string	No	User's real name, not unique	Zhang San
nickname	string	No	Nickname	Zhang San
photo	string	No	Avatar link	https://files.authing.co/authing-console/default-user-avatar.png
loginsCount	number	No	Total number of historical logins	3
lastLogin	string	No	Last login time	2022-07-03T03:20:30.000Z
lastIp	string	No	Last login IP	127.0.0.1
gender	string	Yes	Gender: - M: Male, male - F: female - U: unknown, unknown	M
emailVerified	boolean	yes	Email verified	true
phoneVerified	boolean	yes	Phone number verified	true
passwordLastSetAt	string	no	User's last password modification time	2022-07-03T03:20:30.000Z
birthdate	string	no	Date of birth	2022-06-03
country	string	no	Country	CN
province	string	no	Province	BJ
city	string	no	City	BJ
address	string	no	Address	Beijing Chaoyang
streetAddress	string	no	Street address	Beijing Chaoyang District xxx Street
postalCode	string	no	Postal code	438100
company	string	no	company	steamory
browser	string	no	The browser used when logging in last	Mozilla/5.0 (Linux; Android 10; V2001A; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/87.0.4280.141 Mobile Safari/537.36 VivoBrowser/10.2.10.0
device	string	no	The device used when logging in last	iOS
givenName	string	no	First Name	xx
familyName	string	no	Last Name	xx
middleName	string	no	Middle Name	James
profile	string	no	Preferred Username	alice
preferredUsername	string	no	Preferred Username	alice
website	string	no	User's personal website	https://my-website.com
zoneinfo	string	no	User time zone information	GMT-08:00
locale	string	no	Locale	af
formatted	string	no	Full standard address	132, My Street, Kingston, New York 12401.
region	string	no	User's region	Xinjiang Uyghur Autonomous Region
userSourceType	string	yes	Source type: - excel: Imported through excel - register: User self-registration - adminCreated: Manual creation by the administrator backend (including creating users using the management API) - syncTask: Synchronization task of the synchronization center	excel
userSourceId	string	no	Application ID or synchronization task ID
lastLoginApp	string	no	Application ID of the user's last login
mainDepartmentId	string	no	User's main department ID
lastMfaTime	string	no	Time when the user last performed MFA authentication
passwordSecurityLevel	number	no	User password security strength level	1
resetPasswordOnNextLogin	boolean	no	Require password reset at next login
registerSource	array	no	Registration method
departmentIds	array	No	List of department IDs to which the user belongs	["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]
identities	array	No	External identity source Nested type: <a IdentityDto.
identityNumber	string	No	User ID number	420421xxxxxxxx1234
customData	object	No	User's extended field data	{"school":"Peking University","age":22}
postIdList	array	No	User's associated department ID
statusChangedAt	string	No	User status last modified time	2022-07-03T03:20:30.000Z
tenantId	string	No	User tenant ID

IdentityDto

Name	Type	Is it required	Description	Sample value
identityId	string	yes	Identity source ID	62299d8b866d2dab79a89dc4
extIdpId	string	yes	Identity source connection ID	6076bacxxxxxxxxd80d993b5
provider	string	yes	External identity source type: - wechat: WeChat - qq: QQ - wechatwork: WeChat for Business - dingtalk: DingTalk - weibo: Weibo - github: GitHub - alipay: Alipay - baidu: Baidu - lark: Feishu - welink: Welink - yidun: NetEase Yidun - qingcloud: Qingyun - google: Google - gitlab: GitLab - gitee: Gitee - twitter: Twitter - facebook: Facebook - slack: Slack - linkedin: Linkedin - instagram: Instagram - oidc: OIDC-based enterprise identity source - oauth2: OAuth2-based enterprise identity source - saml: SAML-based enterprise identity source - ldap: LDAP-based enterprise identity source - ad: AD-based enterprise identity source - cas: CAS-based enterprise identity source - azure-ad: Azure AD-based enterprise identity source	oidc
type	string	yes	Identity type, such as unionid, openid, primary	openid
userIdInIdp	string	yes	ID in the external identity source	oj7Nq05R-RRaqak0_YlMLnnIwsvg
userInfoInIdp	object	yes	User information in idp
accessToken	string	no	Access Token in the external identity source (this parameter is only returned when the user actively obtains it, and the management side interface will not return it).	57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx
refreshToken	string	no	Refresh Token in the external identity source (this parameter is only returned when the user actively obtains it, and the management side interface will not return it).	57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx
originConnIds	array	yes	The list of identity source connection IDs from which the identity comes	A["605492AS41XXXXXXXX0362F0707"]A