調用ListGroups查詢用戶組列表。
接口說明
本文將提供一個示例,查詢目錄d-00fc2p61****
下的用戶組列表。返回結果顯示,該目錄下一共存在 3 個用戶組,其中group1
和group2
是從外部同步的用戶組,TestGroup
是云 SSO 內部手動創建的用戶組。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cloudsso:ListGroups | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DirectoryId | string | 是 | 目錄 ID。 | d-00fc2p61**** |
NextToken | string | 否 | 查詢返回結果下一頁的令牌。首次調用 API 不需要 當您首次調用 API 時,如果返回數據總條數超過 | K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4**** |
MaxResults | integer | 否 | 每頁的最大數據條數。 取值范圍:1~100。 默認值:10。 | 10 |
Filter | string | 否 | 過濾條件。 格式: 示例:Filter = "GroupName sw test",表示查詢名稱以 test 開頭的全部用戶組。Filter = "GroupName eq testgroup",表示查詢名稱為 testgroup 的用戶組。 | GroupName eq testgroup |
ProvisionType | string | 否 | 用戶組的類型,用于查詢的過濾條件。取值:
| Manual |
返回參數
示例
正常返回示例
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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|