ListGroupMembers API で CloudSSO グループメンバーをクエリ - CloudSSO

グループ内のユーザーを照会します。

操作説明

このトピックでは、グループ g-00jqzghi2n3o5hkh**** 内のユーザーを照会する例を紹介します。レスポンスの例では、このグループにユーザー Alice と user1 が含まれていることが示されます。

今すぐお試しください

この 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:ListGroupMembers

list

*Group

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GroupId	string	必須	グループの ID。	g-00jqzghi2n3o5hkh****
DirectoryId	string	必須	ディレクトリの ID。	d-00fc2p61****
NextToken	string	任意	次のリクエストで新しい結果ページを取得するために使用されるページネーショントークンです。最初のリクエストでは、このパラメーターを指定する必要はありません。前のクエリから取得したトークンを `NextToken` の値として指定する必要があります。この操作を初めて呼び出す際に、返されるエントリの総数が `MaxResults` パラメーターの値を超えている場合、結果はページング処理されます。システムは `MaxResults` で指定された数のエントリのみを返し、残りのエントリは返しません。このとき、レスポンスパラメーター `IsTruncated` の値は `true` になり、次ページを取得するための `NextToken` パラメーターが返されます。次回の呼び出しで、この `NextToken` の値を指定し、他のリクエストパラメーターを維持することで、残りのエントリを取得できます。`IsTruncated` の値が `false` になるまでこの操作を繰り返すことで、すべてのエントリを取得できます。	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	任意	1ページあたりのエントリ数。有効な値：1～100。デフォルト値：10。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
NextToken	string	ページネーショントークン。次のリクエストで新しい結果ページを取得するために使用できます。説明このパラメーターは、`IsTruncated` パラメーターの値が `true` の場合にのみ返されます。	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	リクエスト ID。	BB759F84-2C64-5C36-B6C6-253172C5C370
TotalCounts	integer	返されたエントリの総数。	2
MaxResults	integer	1ページあたりのエントリ数。	10
IsTruncated	boolean	照会されたエントリが切り捨てられたかどうかを示します。有効な値： true false	false
GroupMembers	array<object>	グループ内のユーザー。
	object	グループ内のユーザー。
Status	string	ユーザーのステータス。有効な値： Enabled：ユーザーのログインが有効になっています。 Disabled：ユーザーのログインが無効になっています。	Enabled
UserName	string	ユーザーの名前。	Alice
Email	string	ユーザーのメールアドレス。	AliceLee@example.com
Description	string	ユーザーの説明。	This is a user.
UserId	string	ユーザーの ID。	u-00q8wbq42wiltcrk****
ProvisionType	string	ユーザーのタイプ。有効な値： Manual：ユーザーは手動で作成されます。 Synchronized：ユーザーは外部 ID プロバイダー (IdP) から同期されます。	Manual
DisplayName	string	ユーザーの表示名。	Alice
JoinTime	string	ユーザーがグループに追加された時刻。	2021-11-01T06:58:18Z
GroupId	string	グループの ID。	g-00jqzghi2n3o5hkh****

例

成功レスポンス

JSONJSON

{
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "BB759F84-2C64-5C36-B6C6-253172C5C370",
  "TotalCounts": 2,
  "MaxResults": 10,
  "IsTruncated": false,
  "GroupMembers": [
    {
      "Status": "Enabled",
      "UserName": "Alice",
      "Email": "AliceLee@example.com",
      "Description": "This is a user.",
      "UserId": "u-00q8wbq42wiltcrk****",
      "ProvisionType": "Manual",
      "DisplayName": "Alice",
      "JoinTime": "2021-11-01T06:58:18Z",
      "GroupId": "g-00jqzghi2n3o5hkh****"
    }
  ]
}

エラーコード

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

変更履歴

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