すべてのプロダクト
Search
ドキュメントセンター

CloudSSO:ListGroups

最終更新日:Dec 20, 2025

グループをクエリします。

操作説明

このトピックでは、ディレクトリ d-00fc2p61**** 内のグループをクエリする例を示します。返された結果から、このディレクトリに 3 つのグループが含まれていることがわかります。グループ group1group2 は外部 ID プロバイダー (IdP) から同期されたもので、グループ TestGroup は CloudSSO で手動で作成されたものです。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cloudsso:ListGroups

list

*Group

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DirectoryId

string

必須

ディレクトリの ID。

d-00fc2p61****

NextToken

string

任意

次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。最初のリクエストでは、このパラメーターを指定する必要はありません。前のクエリから取得したトークンを NextToken の値として指定する必要があります。

この操作を初めて呼び出す際に、返されるエントリの総数が MaxResults パラメーターの値を超えている場合、エントリは切り捨てられます。システムは MaxResults パラメーターの値に基づいてエントリを返し、超過分は返しません。この場合、レスポンスパラメーター IsTruncated の値は true となり、NextToken パラメーターが返されます。次の呼び出しでは、NextToken パラメーターの値を使用し、他のリクエストパラメーターの設定を維持することで、超過したエントリをクエリできます。IsTruncated の値が false になるまで呼び出しを繰り返すことで、すべてのエントリが返されます。

K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****

MaxResults

integer

任意

1 ページあたりのエントリ数。

有効値:1~100。

デフォルト値:10。

10

Filter

string

任意

フィルター条件。

値は <Attribute> <Operator> <Value> の形式で指定する必要があります。値では大文字と小文字は区別されません。<Attribute>GroupName にのみ設定でき、<Operator>eq または sw にのみ設定できます。値 `eq` は「等しい」を、値 `sw` は「次で始まる」を意味します。

たとえば、Filter を GroupName sw test に設定すると、名前が test で始まるグループがクエリされます。Filter を GroupName eq testgroup に設定すると、名前が testgroup のグループがクエリされます。

GroupName eq testgroup

ProvisionType

string

任意

グループのタイプ。このタイプを使用してグループをフィルターできます。有効値は次のとおりです:

  • Manual:手動で作成されたグループ。

  • Synchronized:外部 IdP から同期されたグループ。

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:外部 IdP から同期されたグループ。

Manual

UpdateTime

string

グループの情報が変更された時間。

2021-11-01T02:38:27Z

GroupId

string

グループの ID。

g-00jqzghi2n3o5hkh****

MaxResults

integer

1 ページあたりのエントリ数。

10

TotalCounts

integer

返されたエントリの総数。

3

IsTruncated

boolean

クエリされたエントリが切り捨てられているかどうかを示します。有効値は次のとおりです:

  • true

  • false

false

成功レスポンス

JSONJSON

{
  "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
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。