グループをクエリします。
操作説明
このトピックでは、ディレクトリ d-00fc2p61**** 内のグループをクエリする例を示します。返された結果から、このディレクトリに 3 つのグループが含まれていることがわかります。グループ group1 と group2 は外部 ID プロバイダー (IdP) から同期されたもので、グループ TestGroup は CloudSSO で手動で作成されたものです。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cloudsso:ListGroups |
list |
*Group
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DirectoryId |
string |
必須 |
ディレクトリの ID。 |
d-00fc2p61**** |
| NextToken |
string |
任意 |
次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。最初のリクエストでは、このパラメーターを指定する必要はありません。前のクエリから取得したトークンを この操作を初めて呼び出す際に、返されるエントリの総数が |
K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4**** |
| MaxResults |
integer |
任意 |
1 ページあたりのエントリ数。 有効値:1~100。 デフォルト値:10。 |
10 |
| Filter |
string |
任意 |
フィルター条件。 値は たとえば、Filter を GroupName sw test に設定すると、名前が test で始まるグループがクエリされます。Filter を GroupName eq testgroup に設定すると、名前が testgroup のグループがクエリされます。 |
GroupName eq testgroup |
| ProvisionType |
string |
任意 |
グループのタイプ。このタイプを使用してグループをフィルターできます。有効値は次のとおりです:
|
Manual |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| NextToken |
string |
ページネーショントークン。次のリクエストで結果の新しいページを取得するために使用できます。 説明
このパラメーターは、 |
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 |
| UpdateTime |
string |
グループの情報が変更された時間。 |
2021-11-01T02:38:27Z |
| GroupId |
string |
グループの ID。 |
g-00jqzghi2n3o5hkh**** |
| MaxResults |
integer |
1 ページあたりのエントリ数。 |
10 |
| TotalCounts |
integer |
返されたエントリの総数。 |
3 |
| IsTruncated |
boolean |
クエリされたエントリが切り捨てられているかどうかを示します。有効値は次のとおりです:
|
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
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。