調(diào)用ListUsers查詢用戶列表。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| cloudsso:ListUsers | list | *User acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/* |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DirectoryId | string | 是 | 目錄 ID。 | d-00fc2p61**** |
| Status | string | 否 | 用戶狀態(tài)，用于查詢的過濾條件。取值：
| Enabled |
| ProvisionType | string | 否 | 用戶類型，用于查詢的過濾條件。取值：
| Manual |
| Filter | string | 否 | 過濾條件。 格式： 示例：Filter = "UserName sw test"，表示查詢用戶名稱以 test 開頭的全部用戶。Filter = "UserName eq testuser"，表示查詢用戶名稱為 | UserName sw test |
| MaxResults | integer | 否 | 每頁的最大數(shù)據(jù)條數(shù)。 取值范圍：1~100。 默認值：10。 | 10 |
| NextToken | string | 否 | 查詢返回結(jié)果下一頁的令牌。首次調(diào)用 API 不需要 當您首次調(diào)用 API 時，如果返回數(shù)據(jù)總條數(shù)超過 | K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4**** |
返回參數(shù)
示例
正常返回示例
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"
}
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-03-29 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |