作成¶
POST /api/v1/workspace/member_group/add
概要¶
ワークスペースのチームとそのメンバー、ロールの関連付けを作成します。
呼び出し前および使用手順¶
まずワークスペースメンバーリストからワークスペースメンバーを準備し、ロールリストからチームに割り当て可能なロールを選択します。チームロールはメンバーが継承でき、変更後はアラートキャッシュがクリアされ、権限が非同期で更新されます。成功レスポンスを、ログイン済みのすべてのセッションが直ちに更新されたものと見なさないでください。作成時には無効なメンバーや任意のカスタムロールUUIDが自動的にフィルタリングされないため、事前に取得したリストの実際の値を使用する必要があります。メンバーUUIDの重複排除を推奨します。データベースと後続のキャッシュ/タスク処理は段階的に実行されるため、タイムアウトまたは500が発生した場合は、まずリストまたは詳細を確認して結果を確かめ、重複作成や新しい設定の上書きを避けてください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| accountUUIDs[*] | string | 単一のワークスペースメンバーアカウントUUID文字列。変更時、現在のメンバー範囲に含まれないUUIDはフィルタリングされます。作成時、このインターフェースではメンバーの実在を検証しません。 例: acnt_example取得または入力方法: ワークスペースメンバーリストで返されるメンバーのuuidから取得します。 |
|
| roleUUIDs[*] | string | 単一のロールUUID文字列。作成時、任意のカスタムUUIDが有効であることは保証されないため、リストの実際の値を使用してください。 例: role_example取得または入力方法: ロールリストのロールuuidからコピーし、ownerとwsAdminを除外します。 |
|
| accountUUIDs | array | メンバーUUIDの完全な配列。作成時に省略またはnullの場合、メンバーは追加されません。変更時は必須で、全体を置き換えます。[]はメンバーをクリアし、nullは内部エラーを引き起こすため、[]の代わりには使用できません。 null を許可: True 例: ["acnt_example"]取得または入力方法: ワークスペースメンバーリストからこのワークスペースの実際のメンバーUUIDを取得します。詳細のmembersNotInGroupも候補を提供できます。 |
|
| name | string | Y | チーム名。最大48文字。同じワークスペース内のアクティブなチーム間で名前を重複させることはできません。 null を許可: False 最大長: 48 例: 生产运维取得または入力方法: チームリストでワークスペース内の既存名を確認し、空でない名前を入力します。 |
| roleUUIDs | array | チームに関連付けるロールの完全な配列。作成時に省略またはnullの場合、ロールは追加されません。変更時は必須で、全体を置き換えます。[]またはnullはロールをクリアするため、明示的に[]を使用することを推奨します。チームを通じて所有者または管理者ロールを付与することはできません。 null を許可: True 例: ["role_example"]取得または入力方法: ロールリストから割り当て可能なロールUUIDを取得します。ownerまたはwsAdminは使用できません。 |
パラメータの補足説明¶
作成レスポンスはuuidのみを提供し、チームの完全なエンティティは返しません。変更レスポンスはtrueです。実際のメンバーとロールはリストまたは詳細から読み取ってください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/workspace/member_group/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产运维","accountUUIDs":["acnt_example"],"roleUUIDs":["role_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 作成結果。 |
| content.uuid | string | 作成されたチームUUID。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"uuid": "group_example",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSONトップレベルがオブジェクトではない | 一部の json ファイルの形式エラー | 単一のJSONオブジェクトを使用してください。 |
| 400 | ft.MemberGroupNameExists | このワークスペースに同名のアクティブなチームが既に存在する | 同名のチームが既に存在します | 既存の名前を確認し、未使用のチーム名を選択してください。 |
| 400 | ft.TeamRoleAddPermissionError | roleUUIDsにownerまたはwsAdminが含まれている | チームロールは管理者、所有者にできません | owner/wsAdminの指定を削除し、許可されたロールのみを使用してください。このインターフェースではチームの認可制限を回避できません。 |
| 406 | ft.MissingParameters | チーム名が空 | パラメータ不足 | 空でないnameを指定してください。 |
| 500 | ft.InternalServerError | データベース、通知キャッシュのクリア、非同期権限更新の投入、または監査に失敗 | 内部エラー | まずチーム設定が既に有効になっているか確認し、確認後に再試行するか決定してください。traceIdを記録してください。modifyのaccountUUIDs=nullでもこのエラーが発生する可能性があるため、明示的な配列を使用してください。 |