文档

ListUsers - 查询用户列表

更新时间:
一键部署

调用ListUsers查询用户列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cloudsso:ListUsersRead
  • User
    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/*

请求参数

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

目录 ID。

d-00fc2p61****
Statusstring

用户状态,用于查询的过滤条件。取值:

  • Enabled:启用。
  • Disabled:禁用。
Enabled
ProvisionTypestring

用户类型,用于查询的过滤条件。取值:

  • Manual:手动创建。
  • Synchronized:外部同步。
Manual
Filterstring

过滤条件。

格式:<Attribute> <Operator> <Value>,不区分大小写。目前<Attribute>只支持UserNameOperator只支持eq(Equals)和sw(Start With)。

示例:Filter = "UserName sw test",表示查询用户名称以 test 开头的全部用户。Filter = "UserName eq testuser",表示查询用户名称为testuser的用户。

UserName sw test
MaxResultsinteger

每页的最大数据条数。

取值范围:1~100。

默认值:10。

10
NextTokenstring

查询返回结果下一页的令牌。首次调用 API 不需要NextToken

当您首次调用 API 时,如果返回数据总条数超过MaxResults限制,数据会被截断,只返回MaxResults条数据,同时,返回参数IsTruncatedtrue,返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API,其他请求参数保持不变,查询被截断的数据。您可以按此方法经过多次查询,直到IsTruncatedfalse时,表示全部数据查询完毕。

K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****

返回参数

名称类型描述示例值
object

返回结果。

NextTokenstring

查询返回结果下一页的令牌。

说明 只有IsTruncatedtrue时,才显示该参数。
K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestIdstring

请求 ID。

734D9AAC-9A8E-5DF6-A633-ADE70FF2A9B1
MaxResultsinteger

每页的最大数据条数。

10
TotalCountsinteger

符合请求参数条件的数据总条数。

2
IsTruncatedboolean

返回结果是否被截断。取值:

  • true:已截断。
  • false:未截断。
false
Usersobject []

用户列表。

Statusstring

用户的状态。取值:

  • Enabled:启用。
  • Disabled:禁用。
Enabled
UserNamestring

用户名称。

AliceLee@example.onmicrosoft.com
Emailstring

用户的电子邮箱。

AliceLee@example.onmicrosoft.com
Descriptionstring

用户的描述。

This is a user.
UserIdstring

用户 ID。

u-00bikzkuzbb58luh****
FirstNamestring

用户的名。

Alice
CreateTimestring

用户的创建时间(UTC 时间)。

2021-06-30T09:20:08Z
ProvisionTypestring

用户的类型。取值:

  • Manual:手动创建。
  • Synchronized:外部同步。
Synchronized
DisplayNamestring

用户的显示名称。

AliceLee
UpdateTimestring

用户的修改时间(UTC 时间)。

2021-06-30T09:20:08Z
LastNamestring

用户的姓。

Lee
ExternalIdobject

外部身份提供商的用户标识符信息。

Idstring

外部身份提供商的用户标识符。

c73******a5fdd5
Issuerstring

外部身份同步渠道,当前仅支持 SCIM 同步。

SCIM

示例

正常返回示例

JSON格式

{
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "734D9AAC-9A8E-5DF6-A633-ADE70FF2A9B1",
  "MaxResults": 10,
  "TotalCounts": 2,
  "IsTruncated": false,
  "Users": [
    {
      "Status": "Enabled",
      "UserName": "AliceLee@example.onmicrosoft.com",
      "Email": "AliceLee@example.onmicrosoft.com",
      "Description": "This is a user.",
      "UserId": "u-00bikzkuzbb58luh****",
      "FirstName": "Alice",
      "CreateTime": "2021-06-30T09:20:08Z",
      "ProvisionType": "Synchronized",
      "DisplayName": "AliceLee",
      "UpdateTime": "2021-06-30T09:20:08Z",
      "LastName": "Lee",
      "ExternalId": {
        "Id": "c73******a5fdd5\n",
        "Issuer": "SCIM"
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-29OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)