ListMembers - AI Coding Assistant Lingma - Alibaba Cloud ドキュメントセンター

この API を呼び出して、メンバーのリストをクエリします。

サポートされているエディション

Enterprise Dedicated Edition

サービスエンドポイントと承認

API リクエスト構文の <domain> をエンドポイントに置き換えるサービスエンドポイントを取得します。
アクセストークンを取得します。
organizationId を取得します。 Lingma コンソールに移動し、[企業設定] > > [組織] の下の [基本情報] ページで組織 ID を確認します。

製品	リソース	必要な権限
組織設定	組織メンバー	読み取り専用

リクエスト構文

GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/members

リクエストヘッダー

パラメータ	タイプ	必須	説明	サンプル値
`x-yunxiao-token`	文字列	はい	アクセストークン。	pt-0fh3**0fbG_35af**0484

リクエストパラメータ

パラメータ	タイプ	位置	必須	説明	サンプル値
`organizationId`	string	path	はい	組織の ID。	99d1****71d4
`page`	integer	query	いいえ	ページ番号。デフォルト値: 1。	1
`perPage`	integer	query	いいえ	1 ページあたりのエントリ数。デフォルト値: 100。	100

JavaScript で REST API を使用する

curl -X 'GET' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/members
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

レスポンスパラメーター

パラメーター	タイプ	説明	サンプル値
-	配列
-	オブジェクト
`deptIds`	array[string]	メンバーが所属する組織部門のリスト。	["99d1****6124"]
`id`	string	メンバーの ID。	99d1****6124
`joined`	string	メンバーが参加した日時。データベースの作成時間と同じです。	2023-08-31T03:59:16.201Z
`name`	string	メンバーの名前。	Example Name
`organizationId`	string	組織の ID。	99d1****6124
`roleIds`	array[string]	メンバーのロール。	["99d1****6124"]
`status`	string	メンバーのステータス。有効な値： `ENABLED` `DISABLED` `UNDELETED` `DELETED` `NORMAL_USING` `UNVISITED` `ENABLED` は `NORMAL_USING`+`UNVISITED` を意味します。 `UNDELETED` は `ENABLED`+`DISABLED` を意味します。	ENABLED
`userId`	string	ユーザーの ID。	99d1****6124
`visited`	string	最終アクセス時間。	2023-08-31T03:59:16.201Z

成功レスポンスの例

[
    {
        "deptIds": ["99d1****6124"],
        "id": "99d1****6124",
        "joined": "2023-08-31T03:59:16.201Z",
        "name": "Example Name",
        "organizationId": "99d1****6124",
        "roleIds": ["99d1****6124"],
        "status": "ENABLED", // 有効
        "userId": "99d1****6124",
        "visited": "2023-08-31T03:59:16.201Z"
    }
]

レスポンスヘッダー

パラメーター	説明	サンプル値
`x-next-page`	次のページ。	1
`x-page`	現在のページ。	2
`x-per-page`	1 ページあたりのエントリ数。	1
`x-prev-page`	前のページ。	2
`x-total`	エントリの総数。	1
`x-total-pages`	ページの総数。	1

リクエストパラメーター

詳細については、「エラーコード」をご参照ください。