一覧取得¶
GET /api/v1/workspace/member_group/list
概要¶
現在のワークスペースのチームとその有効メンバー、関連ロールを一覧表示します。
呼び出し前と使用手順¶
チーム名の検索のみをサポートし、ページネーションは行わず、content 配列を直接読み取ります。チームレコード ID の昇順です。member_count は、現在のワークスペースで有効かつ解析可能なメンバー情報のみをカウントし、過去の関連レコード数とは異なる場合があります。メンバーとロールのリスト順序は保証されません。空のチームの role_infos は、ロールが設定済みであっても空になる場合があります。権限を確認する必要がある場合は、既存の設定とロール管理画面を併せて確認し、空の配列のみでロールがないと判断しないでください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| search | string | チーム名によるあいまい検索。省略した場合はすべてのアクティブチームを検索します。 null の許可: False 例: 生产取得または入力方法: チーム名のキーワードを入力します。 |
パラメータ補足説明¶
返却される team uuid は、変更、削除、オブジェクト権限設定に使用できます。チームリストには pageIndex/pageSize パラメータはありません。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/workspace/member_group/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode 'search=生产'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | array<object> |
アクティブチームの配列。結果がない場合は []。 |
| content[].id | integer | データベースレコード番号。操作には uuid を使用します。 |
| content[].uuid | string | チーム UUID。 |
| content[].name | string | チーム名。 |
| content[].workspaceUUID | string | 所属ワークスペースの UUID。 |
| content[].status | integer | アクティブチームの場合は 0。 |
| content[].creator | string | 作成者。 |
| content[].updator | string | 更新者。空の場合があります。 |
| content[].createAt | integer | 作成日時の Unix 秒。 |
| content[].updateAt | integer | エンティティ更新日時の Unix 秒。未更新の場合は -1。現在の変更ではこのフィールドが更新される保証はなく、メンバー/ロールが変更されたかどうかの判断には使用できません。 |
| content[].deleteAt | integer | 削除日時の Unix 秒。未削除の場合は -1。 |
| content[].member_count | integer | 現在解析可能な有効メンバー数。 |
| content[].member_name_list | array<string> |
メンバー表示名のリスト。ワークスペースニックネームを優先し、ない場合はアカウント名を使用します。 |
| content[].member_name_list[] | string | 個々のメンバー表示名。 |
| content[].member_infos | array<object> |
有効なメンバー情報。 |
| content[].role_infos | array<object> |
現在のメンバー関連パスから取得したロール概要。空のチームでは空の配列が返る場合があります。 |
| content[].declaration | object または null | 各チームのワークスペース共通宣言。 |
| content[].member_infos[].id | integer | メンバーのデータベース番号。 |
| content[].member_infos[].uuid | string | メンバーアカウントの UUID。 |
| content[].member_infos[].name | string | アカウント表示名。 |
| content[].member_infos[].email | string | アカウントのメールアドレス。 |
| content[].member_infos[].acntWsNickname | string | このワークスペースのニックネーム。未設定の場合は空文字列。 |
| content[].member_infos[].username | string | アカウントのログインユーザー名。 |
| content[].member_infos[].source | string | アカウントのソース。 |
| content[].member_infos[].userIconUrl | string | アバター URL。未設定の場合は空文字列。 |
| content[].member_infos[].exterId | string | 外部 ID システムの ID。空の場合があります。 |
| content[].member_infos[].mobile | string | 携帯電話番号。空の場合があります。 |
| content[].member_infos[].countryCode | string | 携帯電話番号の国/地域コード。空の場合があります。 |
| content[].member_infos[].namespace | string | アカウントの名前空間。 |
| content[].member_infos[].attributes | JSON 値 | アカウントの元の属性。通常はオブジェクトまたは配列で、解析に失敗した場合は {}。 |
| content[].member_infos[].attributes.动态字段 | JSON 値 | ID プロバイダーが定義する元の属性名と値。統一された固定構造はありません。 |
| content[].member_infos[].customAttributes | JSON 値 | アカウントのカスタム属性。通常はオブジェクトまたは配列で、解析に失敗した場合は {}。 |
| content[].member_infos[].customAttributes.动态字段 | JSON 値 | ユーザーまたは ID システムで設定されたカスタム属性。 |
| content[].member_infos[].defaultWebhook | object | 一部の agent メンバーにのみ存在する元の Webhook 設定。通常のメンバーでは省略されます。 |
| content[].member_infos[].defaultWebhook.动态字段 | JSON 値 | agent が保存済みの設定フィールド。API はそのまま読み取るだけで、固定の子フィールド契約はありません。 |
| content[].role_infos[].uuid | string | ロール UUID または組み込みロール識別子。roleUUIDs の要素として使用できます。 |
| content[].role_infos[].name | string | ロール表示名。 |
{
"code": 200,
"content": [
{
"id": 42,
"uuid": "group_example",
"name": "生产运维",
"workspaceUUID": "wksp_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"member_count": 1,
"member_name_list": [
"运维成员"
],
"member_infos": [
{
"id": 1,
"uuid": "acnt_example",
"name": "运维成员",
"email": "xxx@guance.com",
"acntWsNickname": "",
"username": "xxx@guance.com",
"source": "local",
"userIconUrl": "",
"exterId": "",
"mobile": "",
"countryCode": "",
"namespace": "",
"attributes": {},
"customAttributes": {}
}
],
"role_infos": [
{
"uuid": "role_example",
"name": "运维只读"
}
],
"declaration": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している | パラメータ解析に失敗 | Query パラメータ表と例を確認します。 |
| 500 | ft.InternalServerError | データベースまたはメンバー情報の読み取りに失敗した | 内部エラー | traceId を記録し、後で再試行するかサポートに連絡します。 |