ListGroups查詢使用者組列表-雲SSO-阿里雲

調用ListGroups查詢使用者組列表。

介面說明

本文將提供一個樣本，查詢目錄d-00fc2p61****下的使用者組列表。返回結果顯示，該目錄下一共存在 3 個使用者組，其中group1和group2是從外部同步的使用者組，TestGroup是雲 SSO 內部手動建立的使用者組。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cloudsso:ListGroups

list

*Group

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

無

請求參數

名稱	類型	必填	描述	樣本值
DirectoryId	string	是	目錄 ID。	d-00fc2p61****
NextToken	string	否	查詢返回結果下一頁的令牌。首次調用 API 不需要`NextToken`。當您首次調用 API 時，如果返回資料總條數超過`MaxResults`限制，資料會被截斷，只返回`MaxResults`條資料，同時，返回參數`IsTruncated`為`true`，返回一個`NextToken`。您可以使用上一次返回的`NextToken`繼續調用 API，其他請求參數保持不變，查詢被截斷的資料。您可以按此方法多次查詢，直到`IsTruncated`為`false`，表示全部資料查詢完畢。	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	否	每頁的最巨量資料條數。取值範圍：1~100。預設值：10。	10
Filter	string	否	過濾條件。格式：`<Attribute> <Operator> <Value>`，不區分大小寫。目前，`<Attribute>`只支援`GroupName`，`<Operator>`只支援`eq`（Equals）和`sw`（Start With）。樣本：Filter = "GroupName sw test"，表示查詢名稱以 test 開頭的全部使用者組。Filter = "GroupName eq testgroup"，表示查詢名稱為 testgroup 的使用者組。	GroupName eq testgroup
ProvisionType	string	否	使用者組的類型，用於查詢的過濾條件。取值： Manual：手動建立。 Synchronized：外部同步。	Manual

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
NextToken	string	查詢返回結果下一頁的令牌。說明只有`IsTruncated`為`true`時，才顯示該參數。	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	請求 ID。	768F908D-A66A-5A5D-816C-20C93CBBFEE3
Groups	array<object>	使用者組列表。
	object	使用者組列表。
GroupName	string	使用者組的名稱。	TestGroup
Description	string	使用者組的描述。	This is a group.
CreateTime	string	使用者組的建立時間。	2021-11-01T02:38:27Z
ProvisionType	string	使用者組的類型。取值： Manual：手動建立。 Synchronized：外部同步。	Manual
UpdateTime	string	使用者組的修改時間。	2021-11-01T02:38:27Z
GroupId	string	使用者組的 ID。	g-00jqzghi2n3o5hkh****
MaxResults	integer	每頁的最巨量資料條數。	10
TotalCounts	integer	符合請求參數條件的資料總條數。	3
IsTruncated	boolean	返回結果是否被截斷。取值： true：已截斷。 false：未截斷。	false

樣本

正常返回樣本

JSON格式

{
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "768F908D-A66A-5A5D-816C-20C93CBBFEE3",
  "Groups": [
    {
      "GroupName": "TestGroup",
      "Description": "This is a group.",
      "CreateTime": "2021-11-01T02:38:27Z",
      "ProvisionType": "Manual",
      "UpdateTime": "2021-11-01T02:38:27Z",
      "GroupId": "g-00jqzghi2n3o5hkh****"
    }
  ],
  "MaxResults": 10,
  "TotalCounts": 3,
  "IsTruncated": false
}

錯誤碼

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

變更歷史

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