Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

Data Types

Last updated: 2024-11-13 19:47:16

ErrorDetails

Failure details

Used by actions: CreateApiImportUserJob, CreateFileExportUserJob, ListJobs.

Name	Type	Description
UserId	String	User information Note: This field may return null, indicating that no valid values can be obtained.
Error	String	Failure cause

ExportPropertyMap

Exported attribute mapping

Used by actions: CreateFileExportUserJob.

Name	Type	Required	Description
UserPropertyCode	String	Yes	User attribute code
ColumnName	String	Yes	User attribute mapping name

FailedUsers

Failed user

Used by actions: CreateApiImportUserJob, CreateFileExportUserJob, ListJobs.

Name	Type	Description
FailedUserIdentification	String	ID of the failed user Note: This field may return null, indicating that no valid values can be obtained.
FailedReason	String	Failure cause for user import Note: This field may return null, indicating that no valid values can be obtained.

Filter

Query condition

Used by actions: CreateFileExportUserJob, ListLogMessageByCondition, ListUser.

Name	Type	Required	Description
Key	String	No	Key value
Values	Array of String	No	Value
Logic	Boolean	No	Logical value

ImportUser

Import user information.

At least one of the following nine attributes should be included during the import: UserName, PhoneNumber, Email, WeChatOpenId, WeChatUnionId, AlipayUserId, QQOpenId, QQUnionId, and WeComUserId. Each of these attributes should adhere to the regular expression rules for initial custom attributes. The regular expressions for UserName, PhoneNumber, and Email can be queried in Custom Attributes on the console.
For the import of passwords, plaintext import, MD5 ciphertext import, SHA1 ciphertext import, and BCRYPT ciphertext import are supported. The import method should be specified in the PasswordEncryptTypeEnum field.
IdentityVerified and IdentityVerificationMethod can be imported.
When IdentityVerified is true, IdentityVerificationMethod should be entered.
When IdentityVerificationMethod is nameAndIdCard, Name and ResidentIdentityCard should be entered.
When IdentityVerificationMethod is nameIdCardAndPhone, Name, PhoneNumber, and ResidentIdentityCard should be entered.

Used by actions: CreateApiImportUserJob.

Name	Type	Required	Description
UserName	String	No	Username
PhoneNumber	String	No	Mobile number
Email	String	No	Email address
ResidentIdentityCard	String	No	ID card number
Nickname	String	No	Nickname
Address	String	No	Address
UserGroup	Array of String	No	User group ID
QqOpenId	String	No	`qqOpenId` on QQ
QqUnionId	String	No	`qqUnionId` on QQ
WechatOpenId	String	No	`wechatOpenId` on WeChat
WechatUnionId	String	No	`wechatUnionId` on WeChat
AlipayUserId	String	No	`alipayUserId` on Alipay
WeComUserId	String	No	WeCom user ID.
Description	String	No	Description
Birthdate	Date	No	Date of birth
Name	String	No	Name
Locale	String	No	Coordinate
Gender	String	No	Gender. Valid values: `MALE`, `FEMALE`, `UNKNOWN`.
IdentityVerificationMethod	String	No	Identity verification method
IdentityVerified	Boolean	No	Whether the identity is verified
Job	String	No	Job
Nationality	String	No	Country/Region
Zone	String	No	Time zone
Password	String	No	Password ciphertext
CustomizationAttributes	Array of MemberMap	No	Custom attribute
Salt	Salt	No	Password salt
PasswordEncryptTypeEnum	String	No	Password encryption method. Valid values: `SHA1`, `BCRYPT`.
IndexedAttribute1	String	No	Index field 1
IndexedAttribute2	String	No	Index field 2
IndexedAttribute3	String	No	Index field 3
IndexedAttribute4	String	No	Index field 4
IndexedAttribute5	String	No	Index field 5

Job

Task details

Used by actions: CreateApiImportUserJob, CreateFileExportUserJob, ListJobs.

Name	Type	Description
Id	String	Task ID
Status	String	Task status PENDING Pending PROCESSING Executing COMPLETED Completed FAILED Failed
Type	String	Task type IMPORT_USER User import EXPORT_USER User export
CreatedDate	Integer	Task creation time
Format	String	Data type of the task NDJSON New-line Delimited JSON CSV Comma-Separated Values Note: this field may return null, indicating that no valid values can be obtained.
Location	String	Task result download address Note: This field may return null, indicating that no valid values can be obtained.
ErrorDetails	Array of ErrorDetails	Failure details Note: This field may return null, indicating that no valid values can be obtained.
FailedUsers	Array of FailedUsers	Failed user Note: This field may return null, indicating that no valid values can be obtained.

LogMessage

Log details

Used by actions: ListLogMessageByCondition.

Name	Type	Description
LogId	String	Log ID
TenantId	String	Tenant ID Note: This field may return null, indicating that no valid values can be obtained.
UserStoreId	String	User pool ID Note: This field may return null, indicating that no valid values can be obtained.
EventCode	String	Event code Note: This field may return null, indicating that no valid values can be obtained.
EventDate	Integer	Event timestamp in milliseconds Note: This field may return null, indicating that no valid values can be obtained.
Description	String	Description Note: This field may return null, indicating that no valid values can be obtained.
Participant	String	Event participant TENANT Tenant USER User Note: This field may return null, indicating that no valid values can be obtained.
ApplicationClientId	String	Application `clientId` Note: This field may return null, indicating that no valid values can be obtained.
ApplicationName	String	Application name Note: This field may return null, indicating that no valid values can be obtained.
AuthSourceId	String	Authentication source ID Note: This field may return null, indicating that no valid values can be obtained.
AuthSourceName	String	Authentication source name Note: This field may return null, indicating that no valid values can be obtained.
AuthSourceType	String	Authentication source type Note: This field may return null, indicating that no valid values can be obtained.
AuthSourceCategory	String	Authentication source category Note: This field may return null, indicating that no valid values can be obtained.
Ip	String	IP address Note: This field may return null, indicating that no valid values can be obtained.
UserAgent	String	User agent Note: This field may return null, indicating that no valid values can be obtained.
UserId	String	User ID Note: This field may return null, indicating that no valid values can be obtained.
Detail	String	Details Note: This field may return null, indicating that no valid values can be obtained.

MemberMap

Map data type

Used by actions: CreateApiImportUserJob, CreateUser, DescribeUser, DescribeUserById, ListUser, ListUserByProperty, UpdateUser.

Name	Type	Required	Description
Name	String	Yes	Key
Value	String	Yes	Value
Type	String	No	Type Note: This field may return null, indicating that no valid values can be obtained.

Pageable

Pagination object

Used by actions: DescribeUser, ListLogMessageByCondition, ListUser.

Name	Type	Required	Description
PageSize	Integer	Yes	Number of entries per page
PageNumber	Integer	Yes	Current page number

QueryUserFilter

Conditions to query the user information

Used by actions: DescribeUser.

Name	Type	Required	Description
PropertyKey	String	No	Property key
PropertyValue	String	No	Property value
Logic	Boolean	No	Logic value. `True` or `False`
OperateLogic	String	No	Operator. Values: `>`, `<`, `=`, `>=`, `<=`, `!=` and `between`.

Salt

Password salt

Used by actions: CreateApiImportUserJob.

Name	Type	Required	Description
SaltValue	String	No	Salt value
SaltLocation	SaltLocation	No	Salt value location

SaltLocation

Salt location

Used by actions: CreateApiImportUserJob.

Name	Type	Required	Description
SaltLocationTypeEnum	String	No	Password salt type. Valid values: `HEAD`, `TAIL`, `OTHER`.
SaltLocationRule	SaltLocationRule	No	Salting rule

SaltLocationRule

Salt location rule

Used by actions: CreateApiImportUserJob.

Name	Type	Required	Description
Regex	String	No	Expression

Sort

Sorting of the result of user query

Used by actions: DescribeUser.

Name	Type	Required	Description
PropertyKey	String	No	Key for sorting. See custom attributes
Order	String	No	`ASC` or `DESC`

User

User information

Used by actions: CreateUser, DescribeUser, DescribeUserById, ListUser, ListUserByProperty, UpdateUser.

Name	Type	Description
UserId	String	User ID
UserName	String	Username Note: This field may return null, indicating that no valid values can be obtained.
PhoneNumber	String	Mobile number Note: This field may return null, indicating that no valid values can be obtained.
Email	String	Email address Note: This field may return null, indicating that no valid values can be obtained.
LastSignOn	Integer	Last login time Note: This field may return null, indicating that no valid values can be obtained.
CreatedDate	Integer	Creation time
Status	String	Status
UserDataSourceEnum	String	User source
Nickname	String	Nickname Note: This field may return null, indicating that no valid values can be obtained.
Address	String	Address Note: This field may return null, indicating that no valid values can be obtained.
Birthdate	Integer	Date of birth Note: This field may return null, indicating that no valid values can be obtained.
UserGroups	Array of String	User group ID Note: This field may return null, indicating that no valid values can be obtained.
LastModifiedDate	Integer	Last modified time Note: This field may return null, indicating that no valid values can be obtained.
CustomAttributes	Array of MemberMap	Custom attribute Note: This field may return null, indicating that no valid values can be obtained.
ResidentIdentityCard	String	ID card number Note: This field may return null, indicating that no valid values can be obtained.
QqOpenId	String	`OpenId` on QQ Note: This field may return null, indicating that no valid values can be obtained.
QqUnionId	String	`UnionId` on QQ Note: This field may return null, indicating that no valid values can be obtained.
WechatOpenId	String	`WechatOpenId` on WeChat Note: This field may return null, indicating that no valid values can be obtained.
WechatUnionId	String	`WechatUnionId` on WeChat Note: This field may return null, indicating that no valid values can be obtained.
AlipayUserId	String	`AlipayUserId` on Alipay Note: This field may return null, indicating that no valid values can be obtained.
WeComUserId	String	WeCom user ID. Note: This field may return null, indicating that no valid values can be obtained.
Description	String	Description Note: This field may return null, indicating that no valid values can be obtained.
Name	String	Name Note: This field may return null, indicating that no valid values can be obtained.
Locale	String	Coordinate Note: This field may return null, indicating that no valid values can be obtained.
Gender	String	Gender Note: This field may return null, indicating that no valid values can be obtained.
IdentityVerificationMethod	String	Identity verification method Note: This field may return null, indicating that no valid values can be obtained.
IdentityVerified	Boolean	Whether the identity is verified Note: This field may return null, indicating that no valid values can be obtained.
Job	String	Job Note: This field may return null, indicating that no valid values can be obtained.
Nationality	String	Country/Region Note: This field may return null, indicating that no valid values can be obtained.
Primary	Boolean	Whether the account is the primary account (after account merge, this parameter is `true` for primary accounts and `false` for secondary account). Note: This field may return null, indicating that no valid values can be obtained.
Zone	String	Time zone Note: This field may return null, indicating that no valid values can be obtained.
AlreadyFirstLogin	Boolean	Whether the account has ever logged in. Note: This field may return null, indicating that no valid values can be obtained.
TenantId	String	Tenant ID Note: This field may return null, indicating that no valid values can be obtained.
UserStoreId	String	User directory ID Note: This field may return null, indicating that no valid values can be obtained.
Version	Integer	Version Note: This field may return null, indicating that no valid values can be obtained.
LockType	String	Lock type (locked by admin or locked by login policy) Note: This field may return null, indicating that no valid values can be obtained.
LockTime	Integer	Lock time Note: This field may return null, indicating that no valid values can be obtained.
IndexedAttribute1	String	Index field 1 Note: this field may return null, indicating that no valid values can be obtained.
IndexedAttribute2	String	Index field 2 Note: this field may return null, indicating that no valid values can be obtained.
IndexedAttribute3	String	Index field 3 Note: this field may return null, indicating that no valid values can be obtained.
IndexedAttribute4	String	Index field 4 Note: this field may return null, indicating that no valid values can be obtained.
IndexedAttribute5	String	Index field 5 Note: this field may return null, indicating that no valid values can be obtained.

tencent cloud

Recent Pages

Data Types

ErrorDetails

ExportPropertyMap

FailedUsers

Filter

ImportUser

Job

LogMessage

MemberMap

Pageable

QueryUserFilter

Salt

SaltLocation

SaltLocationRule

Sort

User

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

Data Types

ErrorDetails

ExportPropertyMap

FailedUsers

Filter

ImportUser

Job

LogMessage

MemberMap

Pageable

QueryUserFilter

Salt

SaltLocation

SaltLocationRule

Sort

User

Was this page helpful?

Was this page helpful?