Sync users

更新时间:
复制 MD 格式

Call the CreateUser operation to sync user information to the cloud product platform.

Usage notes

This operation syncs user information to the cloud product platform. If a user already exists, their information is updated. Otherwise, a new user is created.

Request parameters

Parameter

Type

Required

Description

UserInfo

String (Struct)

Yes

The user information, which must be a JSON string. For details about the structure, see the example.

Count

Integer

Yes

The number of users to sync. This value cannot exceed the maximum number of users that the effective concurrency supports.

UserInfo structure

Parameter

Type

Required

Description

userId

String

Yes

The user ID.

userName

String

Yes

The username.

groupId

String

Yes

The enterprise ID.

groupName

String

Yes

The enterprise name.

userAvatarUrl

String

No

The user's profile picture.

departId

String

No

The department ID.

departName

String

No

The department name.

userEmail

String

No

The user's email address.

userTel

String

No

The user's landline number.

userMobile

String

No

The user's mobile number.

Response parameters

Parameter

Type

Description

ErrorCode

int

The error code.

Message

String

The error message.

Success

boolean

The request status.

RequestId

String

The request ID.

Examples

Sample request parameter: UserInfo

[{
    "userId":"123",
    "userName":"Zhang San",
    "groupId":"88",
    "groupName":"Alibaba",
    "userAvatarUrl":"https://example.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-2**-**.png",
    "departId":"1111",
    "departName":"Administration Department",
    "userEmail":"xxxxxxx@xx.com",
    "userTel":"12345678",
    "userMobile":"1381234****"
},{
    "userId":"124",
    "userName":"Li Si",
    "groupId":"88",
    "groupName":"Alibaba",
    "userAvatarUrl":"https://example.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-2**-**.png",
    "departId":"2222",
    "departName":"Human Resources Department",
    "userEmail":"xxxxxxx@xx.com",
    "userTel":"12345678",
    "userMobile":"1381234****"
}]

Response example

{
  "RequestId": "123",
  "Message": "successful!",
  "Success": true,
  "ErrorCode": 0
}