跳到主要内容

用户管理

获取用户列表#

1. 接口描述#

接口功能:获取指定云环境下的用户列表

接口声明:getEndUserList(options: Object): Promise<Object>

2. 输入参数#

字段必填类型说明
limitNumber拉取用户数量
offsetNumber偏移量

3. 返回结果#

字段类型说明
TotalNumber用户总数
RequestIdString请求唯一标识
UsersArray<EndUserInfo>用户信息列表

EndUserInfo

字段类型说明
UUIdString用户唯一 ID
WXOpenIdString微信 ID
QQOpenIdStringqq ID
PhoneString手机号
EmailString邮箱
NickNameString昵称
GenderString性别
AvatarUrlString头像地址
UpdateTimeString更新时间
CreateTimeString创建时间
IsAnonymousBoolean是否为匿名用户
IsDisabledBoolean是否禁用账户
HasPasswordBoolean是否设置过密码
UserNameString用户名

4. 示例代码#

const cloudbaseConfig = {  secretId: "Your SecretId",  secretKey: "Your SecretKey",  envId: "Your envId" // 云开发环境ID,可在腾讯云云开发控制台获取};const app = new CloudBase(cloudBaseConfig);
async function main() {  const { Users } = await app.user.getEndUserList({    limit: 20,    offset: 0  });
  console.log(">>> Users are:", Users);}
main();

创建新用户#

1. 接口描述#

接口功能:在指定云环境下,创建用户名和密码

接口声明:createEndUser(options: Object): Promise<Object>

2. 输入参数#

字段必填类型说明
usernameString用户名
passwordString密码
密码强度要求

密码长度不小于 8 位,不大于 32 位,需要包含字母和数字。

3. 返回结果#

字段类型说明
RequestIdString请求唯一标识
UserEndUserInfo用户信息

4. 示例代码#

const cloudbaseConfig = {  secretId: "Your SecretId",  secretKey: "Your SecretKey",  envId: "Your envId" // 云开发环境ID,可在腾讯云云开发控制台获取};const app = new CloudBase(cloudBaseConfig);
async function main() {  try {    const { User } = await app.user.createEndUser({      username: "your username",      password: "your password"    });
    console.log(">>> 新建用户信息:", User);  } catch (error) {    console.log(">>> 新建用户失败:", error.message);  }}
main();

修改用户账户信息#

1. 接口描述#

接口功能:修改指定云环境下的特定用户的信息

接口声明:modifyEndUser(options: Object): Promise<Object>

2. 输入参数#

字段必填类型说明
uuidString云开发用户唯一标识
usernameString新用户名
passwordString新密码

3. 返回结果#

字段类型说明
RequestIdString请求唯一标识

4. 示例代码#

const cloudbaseConfig = {  secretId: "Your SecretId",  secretKey: "Your SecretKey",  envId: "Your envId" // 云开发环境ID,可在腾讯云云开发控制台获取};const app = new CloudBase(cloudBaseConfig);
async function main() {  try {    await app.user.modifyEndUser({      uuid: "your user uuid",      username: "your new username",      password: "your new password"    });
    console.log(">>> 修改用户账户信息成功");  } catch (error) {    console.log(">>> 修改用户账户信息失败:", error.message);  }}
main();

修改用户信息#

1. 接口描述#

接口功能:修改指定云环境下的特定用户的信息

接口声明:updateEndUser(options: Object): Promise<Object>

2. 输入参数#

字段必填类型说明
uuidString云开发用户唯一标识
nickNameString新昵称
genderString新性别
avatarUrlString新头像
countryString新国家
provinceString新省份
cityString新城市

3. 返回结果#

字段类型说明
RequestIdString请求唯一标识

4. 示例代码#

const cloudbaseConfig = {  secretId: "Your SecretId",  secretKey: "Your SecretKey",  envId: "Your envId" // 云开发环境ID,可在腾讯云云开发控制台获取};const app = new CloudBase(cloudBaseConfig);
async function main() {  try {    await app.user.updateEndUser({      uuid: "your user uuid",      nickName: "your new nickName",      gender: "your new gender",      avatarUrl: "your new avatarUrl",      country: "your new country",      province: "your new province",      city: "your new city"    });
    console.log(">>> 修改用户信息成功");  } catch (error) {    console.log(">>> 修改用户信息失败:", error.message);  }}
main();

设置用户状态#

1. 接口描述#

接口功能:停用或启用云环境下的特定用户

接口声明:setEndUserStatus(options: object): Promise<object>

2. 输入参数#

字段必填类型说明
uuidString云开发用户唯一标识
statusString'DISABLE'或者'ENABLE'

3. 返回结果#

字段类型说明
RequestIdString请求唯一标识

4. 示例代码#

const cloudbaseConfig = {  secretId: "Your SecretId",  secretKey: "Your SecretKey",  envId: "Your envId" // 云开发环境ID,可在腾讯云云开发控制台获取};const app = new CloudBase(cloudBaseConfig);
async function main() {  try {    const { RequestId } = await app.user.setEndUserStatus({      uuid: "User uuid",      status: "DISABLE"    });    console.log(">>> 停用成功");  } catch (error) {    console.log(">>> 停用失败", error.message);  }}
main();

批量删除用户#

1. 接口描述#

接口功能:批量删除指定云环境下的用户

接口声明:deleteEndUsers(options: Object): Promise<Object>

2. 输入参数#

字段必填类型说明
userListArray<String>用户 uuid 列表

3. 返回结果#

字段必填类型说明
RequestIdString请求唯一标识

4. 示例代码#

const cloudbaseConfig = {  secretId: "Your SecretId",  secretKey: "Your SecretKey",  envId: "Your envId" // 云开发环境ID,可在腾讯云云开发控制台获取};
const app = new CloudBase(cloudBaseConfig);
async function main() {  try {    const { RequestId } = await app.user.deleteEndUsers({      userList: [        "uuid a",        "uuid b",        "uuid c"        // ......      ]    });    console.log(">>> 批量删除成功");  } catch (error) {    console.log(">>> 批量删除失败", error.message);  }}
main();