コンテンツにスキップ

変更



POST /api/v1/workspace/member_group/{group_uuid}/modify

概要

ワークスペースのチームとそのメンバー、ロールの関連付けを完全に置き換えます。

呼び出し前と使用手順

まずチーム詳細で既存のチーム名、完全なメンバーとロールを保存し、その後3つの完全なフィールドを送信します。これは部分更新ではありません。accountUUIDs=[] はすべてのメンバーを削除し、roleUUIDs=[] はすべての関連ロールを削除します。空配列の代わりに null を渡すことはできません。まずワークスペースメンバー一覧でワークスペースメンバーを準備し、ロール一覧でチームに割り当て可能なロールを選択します。チームロールはメンバーが継承でき、変更後はアラートキャッシュをクリアし、権限を非同期で更新します。成功レスポンスを、ログイン済みのすべてのセッションが直ちに更新されたと見なすことはできません。データベースと後続のキャッシュ/タスク処理は段階的に実行されるため、タイムアウトや500が発生した場合は、まず一覧または詳細で結果を確認し、重複作成や新しい設定の上書きを避けてください。

ルートパラメータ

パラメータ名 型 必須 説明
group_uuid string Y 対象チームのUUID。現在のワークスペースに属している必要があります。
例: group_example
取得または入力方法: チーム一覧の content[].uuid からチームUUIDを取得します。

リクエストヘッダー

パラメータ名 型 必須 説明
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 Y 完全なメンバーUUID配列。作成時に省略または null の場合はメンバーを追加しません。変更時は必須で、全体を置き換えます。[] はメンバーをクリアし、null は内部エラーを引き起こすため、[] の代わりにはなりません。
null を許可: True
例: ["acnt_example"]
取得または入力方法: ワークスペースメンバー一覧からこのワークスペースの実際のメンバーUUIDを取得します。詳細の membersNotInGroup も候補を提供できます。
name string Y チーム名。最大48文字。同一ワークスペース内のアクティブなチームで重複できません。
null を許可: False
最大長: 48
例: 生产运维
取得または入力方法: チーム一覧でワークスペース内の既存名称を確認し、空でない名称を入力します。
roleUUIDs array Y チームに関連付けるロールの完全な配列。作成時に省略または null の場合はロールを追加しません。変更時は必須で全体を置き換えます。[] または null はロールをクリアするため、明示的に [] を使用することを推奨します。チーム経由で所有者または管理者ロールを付与することはできません。
null を許可: True
例: ["role_example"]
取得または入力方法: ロール一覧から割り当て可能なロールUUIDを取得します。owner または wsAdmin は使用できません。

パラメータ補足説明

作成レスポンスは uuid のみを提供し、チームの完全なエンティティは返しません。変更レスポンスは true です。実際のメンバーとロールは一覧または詳細から読み取ってください。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/workspace/member_group/group_example/modify' \
  -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 boolean 設定の変更が完了すると true。
{
  "code": 200,
  "content": true,
  "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 が含まれている チームロールに管理者、所有者は指定できません 所有者/管理者の指定を削除し、許可されたロールのみを使用してください。このインターフェースでチーム認可の制限を回避することはできません。
404 ft.MemberGroupNoExists 対象チームが存在しない、削除済み、またはこのワークスペースにない チームが存在しません チーム一覧からアクティブなチームUUIDを再度コピーしてください。
500 ft.InternalServerError データベース、通知キャッシュのクリア、非同期権限更新の送信、または監査に失敗 内部エラー まずチーム設定が既に有効になっているか確認し、確認後に再試行するか判断してください。traceId を記録してください。modify の accountUUIDs=null もこのエラーを引き起こす可能性があるため、明示的な配列を使用してください。

フィードバック

このページは役に立ちましたか?