# 用户管理

# 获取用户列表

# 1. 接口描述

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

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

# 2. 输入参数

字段 必填 类型 说明
limit Number 拉取用户数量
offset Number 偏移量

# 3. 返回结果

字段 类型 说明
Total Number 用户总数
RequestId String 请求唯一标识
Users Array<EndUserInfo> 用户信息列表

EndUserInfo

字段 类型 说明
UUId String 用户唯一 ID
WXOpenId String 微信 ID
QQOpenId String qq ID
Phone String 手机号
Email String 邮箱
NickName String 昵称
Gender String 性别
AvatarUrl String 头像地址
UpdateTime String 更新时间
CreateTime String 创建时间
IsAnonymous Boolean 是否为匿名用户
IsDisabled Boolean 是否禁用账户
HasPassword Boolean 是否设置过密码
UserName String 用户名

# 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. 输入参数

字段 必填 类型 说明
username String 用户名
password String 密码

密码强度要求

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

# 3. 返回结果

字段 类型 说明
RequestId String 请求唯一标识
User EndUserInfo 用户信息

# 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. 输入参数

字段 必填 类型 说明
uuid String 云开发用户唯一标识
username String 新用户名
password String 新密码

注意

目前只支持修改用户名和密码。

# 3. 返回结果

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

# 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. 接口描述

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

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

# 2. 输入参数

字段 必填 类型 说明
uuid String 云开发用户唯一标识

# 3. 返回结果

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

# 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.disableEndUser({
      uuid: "User uuid"
    });
    console.log(">>> 停用成功");
  } catch (error) {
    console.log(">>> 停用失败", error.message);
  }
}

main();

# 批量删除用户

# 1. 接口描述

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

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

# 2. 输入参数

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

# 3. 返回结果

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

# 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();