使用ListUsers API查詢使用者列表-雲SSO-阿里雲 - CloudSSO

呼叫 ListUsers 查詢使用者清單。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cloudsso:ListUsers

list

*User

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/*

無

請求參數

名稱	類型	必填	描述	樣本值
DirectoryId	string	是	目錄 ID。	d-00fc2p61****
Status	string	否	使用者狀態，用於查詢的篩選條件。取值： Enabled：已啟用。 Disabled：已停用。	Enabled
ProvisionType	string	否	使用者類型，用於查詢的篩選條件。取值： Manual：手動建立。 Synchronized：外部同步。	Manual
Filter	string	否	篩選條件。格式：`<Attribute> <Operator> <Value>`，不區分大小寫。目前 `<Attribute>` 僅支援 `UserName`，`Operator` 僅支援 `eq`（Equals）和 `sw`（Start With）。範例：Filter = "UserName sw test"，表示查詢使用者名稱以 test 開頭的全部使用者。Filter = "UserName eq testuser"，表示查詢使用者名稱為 `testuser` 的使用者。	UserName sw test
MaxResults	integer	否	每頁的最大資料筆數。取值範圍：1~100。預設值：10。	10
NextToken	string	否	查詢返回結果下一頁的權杖。首次呼叫 API 不需要 `NextToken`。當您首次呼叫 API 時，如果返回資料總筆數超過 `MaxResults` 限制，資料會被截斷，只返回 `MaxResults` 筆資料，同時，返回參數 `IsTruncated` 為 `true`，並返回一個 `NextToken`。您可以使用上一次返回的 `NextToken` 繼續呼叫 API，其他請求參數保持不變，以查詢被截斷的資料。您可以按此方法經過多次查詢，直到 `IsTruncated` 為 `false` 時，表示全部資料查詢完畢。	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
Tags	array<object>	否	標籤清單。
	object	否
Key	string	否	標籤鍵。	TestKey
Value	string	否	標籤值。	TestValue

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
NextToken	string	查詢返回結果下一頁的權杖。說明只有 `IsTruncated` 為 `true` 時，才顯示該參數。	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	請求 ID。	734D9AAC-9A8E-5DF6-A633-ADE70FF2A9B1
MaxResults	integer	每頁的最大資料筆數。	10
TotalCounts	integer	符合請求參數條件的資料總筆數。	2
IsTruncated	boolean	返回結果是否被截斷。取值： true：已截斷。 false：未截斷。	false
Users	array<object>	使用者清單。
	array<object>	使用者清單。
Status	string	使用者的狀態。取值： Enabled：已啟用。 Disabled：已停用。	Enabled
UserName	string	使用者名稱。	AliceLee@example.onmicrosoft.com
Email	string	使用者的電子郵件地址。	AliceLee@example.onmicrosoft.com
Description	string	使用者的描述。	This is a user.
UserId	string	使用者 ID。	u-00bikzkuzbb58luh****
FirstName	string	使用者的名。	Alice
CreateTime	string	使用者的建立時間（UTC 時間）。	2021-06-30T09:20:08Z
ProvisionType	string	使用者的類型。取值： Manual：手動建立。 Synchronized：外部同步。	Synchronized
DisplayName	string	使用者的顯示名稱。	AliceLee
UpdateTime	string	使用者的修改時間（UTC 時間）。	2021-06-30T09:20:08Z
LastName	string	使用者的姓。	Lee
ExternalId	object	外部身分識別提供者的使用者識別碼資訊。
Id	string	外部身份供應商的使用者識別碼。	c73******a5fdd5
Issuer	string	外部身份同步渠道，當前僅支援 SCIM 同步。	SCIM
Tags	array<object>	標籤清單。
	object
Key	string		TestKey
Value	string		TestValue

樣本

正常返回樣本

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"
      },
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ]
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。