QueryUserList - 查询组织成员列表信息

查询组织成员列表信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
quickbi-public:QueryUserListlist
*全部资源
*

请求参数

名称类型必填描述示例值
Keywordstring

组织成员用户名或昵称的关键字。

测试用户
PageNuminteger

组织成员列表的当前页码:

  • 起始值:1
  • 默认值:1
1
PageSizeinteger

分页查询时的每页行数:

  • 默认值:10
  • 最大值:1000
10

返回参数

名称类型描述示例值
object
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

返回用户列表的分页结果,组织成员的详细信息列表存放在返回参数 Data 中。

Dataarray<object>

返回请求的用户列表。

Dataobject
AccountIdstring

阿里云账号 ID。非 Ram 自助读取添加的用户,需要登录后才能获取到阿里云 ID。

1355********
AccountNamestring

阿里云账号名称。

测试用户
AdminUserboolean

是否绑定了组织管理员角色。取值范围:

  • true:是
  • false:否

注意 参数已过期不推荐使用,以 RoleIdList 参数为准

true
AuthAdminUserboolean

是否绑定了权限管理员角色。取值范围:

  • true:是
  • false:否

注意 参数已过期不推荐使用,以 RoleIdList 参数为准

true
JoinedDatelong

加入日期

1718691704000
LastLoginTimelong

最后登录时间。

1718761320681
NickNamestring

组织成员的昵称。

测试用户
RoleIdListarray

用户绑定的组织角色 ID 列表。

roleIdListlong

组织角色 ID,最多 3 个,包括但不限于组织预置角色:

  • 组织管理员(预置角色):111111111
  • 权限管理员(预置角色):111111112
  • 普通用户(预置角色):111111113
111111111
UserIdstring

Quick BI 中的 UserID。

fe67f61a35a94b7da1a34ba174a7****
UserTypeinteger

组织成员的用户类型。取值范围:

  • 1 :开发者
  • 2 :访问者
  • 3 :分析师
1
IsDeletedboolean

用户状态:

  • 激活-false
  • 失效-true
false
PageNuminteger

页码。

1
PageSizeinteger

请求接口时设置的每页行数。

10
TotalNuminteger

总行数。

1
TotalPagesinteger

总页数。

1

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AccountId": "1355********",
        "AccountName": "测试用户",
        "AdminUser": true,
        "AuthAdminUser": true,
        "JoinedDate": 1718691704000,
        "LastLoginTime": 1718761320681,
        "NickName": "测试用户",
        "RoleIdList": [
          111111111
        ],
        "UserId": "fe67f61a35a94b7da1a34ba174a7****",
        "UserType": 1,
        "IsDeleted": false
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-02-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情