QueryUserList を使用して組織メンバーを取得 - Quick BI - Alibaba Cloud -

組織のメンバーの一覧を取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quickbi-public:QueryUserList

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Keyword	string	任意	ユーザー名またはニックネームで組織のメンバーを検索するためのキーワード。	test
PageNum	integer	任意	返すページ番号。開始値： 1 デフォルト値： 1	1
PageSize	integer	任意	1 ページあたりの組織のメンバー数。デフォルト値： 10 最大値： 1000	10

レスポンスフィールド

フィールド	型	説明	例
	object
Success	boolean	リクエストが成功したかどうかを示します。有効な値： `true`：リクエストは成功です。 `false`：リクエストは失敗です。	true
RequestId	string	リクエスト ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	ページ分割されたユーザーリスト。`Data` パラメーターには、各組織メンバーの詳細が含まれます。
Data	array<object>	ユーザーリスト。
	object	ユーザーの詳細。
AccountId	string	Alibaba Cloud アカウント ID。RAM 経由で追加されていないユーザーの場合、この ID はログイン後にのみ使用可能になります。	1355********
AccountName	string	Alibaba Cloud アカウント名。	test
AdminUser	boolean	ユーザーが組織管理者であるかどうかを示します。有効な値： `true`：はい `false`：いいえ重要このパラメーターは非推奨です。代わりに `RoleIdList` パラメーターを使用してください。	true
AuthAdminUser	boolean	ユーザーが権限管理者であるかどうかを示します。有効な値： `true`：はい `false`：いいえ重要このパラメーターは非推奨です。代わりに `RoleIdList` パラメーターを使用してください。	true
JoinedDate	integer	ユーザーが組織に参加した日時を示す UNIX タイムスタンプ (ミリ秒単位)。	1718691704000
LastLoginTime	integer	ユーザーの最終ログイン日時を示す UNIX タイムスタンプ (ミリ秒単位)。	1718761320681
NickName	string	ユーザーのニックネーム。	test
RoleIdList	array	ユーザーに割り当てられた組織ロールの ID。
	integer	組織ロールの ID。ユーザーは最大 3 つのロールを持つことができます。事前定義ロールは次のとおりです：組織管理者 (事前定義ロール)：`111111111` 権限管理者 (事前定義ロール)：`111111112` 一般ユーザー (事前定義ロール)：`111111113`	111111111
UserId	string	Quick BI のユーザー ID。	fe67f61a35a94b7da1a34ba174a7****
UserType	integer	組織メンバーのユーザータイプ。有効な値： `1`：開発者 `2`：閲覧者 `3`：分析者	1
IsDeleted	boolean	ユーザーが非アクティブであるかどうかを示します。 `false`：アクティブ `true`：非アクティブ	false
CopilotModules	array
	string		qreport
PageNum	integer	ページ番号。	1
PageSize	integer	ページあたりのエントリー数。	10
TotalNum	integer	一致するユーザーの総数。	1
TotalPages	integer	総ページ数。	1

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AccountId": "1355********",
        "AccountName": "test",
        "AdminUser": true,
        "AuthAdminUser": true,
        "JoinedDate": 1718691704000,
        "LastLoginTime": 1718761320681,
        "NickName": "test",
        "RoleIdList": [
          111111111
        ],
        "UserId": "fe67f61a35a94b7da1a34ba174a7****",
        "UserType": 1,
        "IsDeleted": false,
        "CopilotModules": [
          "qreport "
        ]
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

エラーコード

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

変更履歴

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