调用ListUsers查询用户列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cloudsso:ListUsers | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DirectoryId | string | 是 | 目录 ID。 | d-00fc2p61**** |
| Status | string | 否 | 用户状态，用于查询的过滤条件。取值：
| Enabled |
| ProvisionType | string | 否 | 用户类型，用于查询的过滤条件。取值：
| Manual |
| Filter | string | 否 | 过滤条件。 格式： 示例：Filter = "UserName sw test"，表示查询用户名称以 test 开头的全部用户。Filter = "UserName eq testuser"，表示查询用户名称为 | UserName sw test |
| MaxResults | integer | 否 | 每页的最大数据条数。 取值范围：1~100。 默认值：10。 | 10 |
| NextToken | string | 否 | 查询返回结果下一页的令牌。首次调用 API 不需要 当您首次调用 API 时，如果返回数据总条数超过 | K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4**** |
返回参数
示例
正常返回示例
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-29 | OpenAPI 返回结构发生变更 | 查看变更详情 |