組織を更新する

PUT /api/v1/organizations/{{id}

Bearer 認証

名前や説明などの組織フィールドを更新します。

path パラメータ

id string 必須

組織ID

application/ JSON

body 必須

更新するフィールド

説明 string
name string

名前は検証前に削除されます。 1-64 文字で、Unicode 文字または数字、スペース、および文字 - _ を含めることができます。（）、、 @ + '.

最小長は 1、最大長は 64 です。

応答

406

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

サポートされていないAPIバージョンまたは不正な API バージョン、選択した公開契約で利用できない操作、または受け入れができない表現（サポートされていないメディアタイプのパラメーター、または除外された SSE を含む）。既存の認証、認可、およびレート制限の失敗が優先されます。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエートエラーでは、このフィールドは出力されません。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  検証に失敗したフィールド。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  フィールドとその検証の失敗。
  
  説明 string 必須
  
  人間が判読できる検証の失敗。
  
  フィールド string 必須
  
  無効なリクエストフィールドの名前またはパス。
- 詳細 string 必須
  
  人間が判読できるエラーの詳細。
- エラー integer 必須
  
  HTTP status code.
- errorCode string 必須
  
  マシンが判読できるエラーコード。
- パラメーター array[string]
  
  エラーに関連付けられたリクエストパラメータ名。該当しない場合は省略します。
- 理由 string 必須
  
  HTTPステータス理由フレーズ。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエートエラーでは、このフィールドは出力されません。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  検証に失敗したフィールド。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  フィールドとその検証の失敗。
  
  説明 string 必須
  
  人間が判読できる検証の失敗。
  
  フィールド string 必須
  
  無効なリクエストフィールドの名前またはパス。
- 詳細 string 必須
  
  人間が判読できるエラーの詳細。
- エラー integer 必須
  
  HTTP status code.
- errorCode string 必須
  
  マシンが判読できるエラーコード。
- パラメーター array[string]
  
  エラーに関連付けられたリクエストパラメータ名。該当しない場合は省略します。
- 理由 string 必須
  
  HTTPステータス理由フレーズ。
200

アプリケーション/vnd.agent- engine-2026-09-20-preview+json

アプリケーション/vnd.agent- engine-2026-09-20-preview+json application/ JSON

OK
応答属性の非表示応答属性の表示オブジェクト
- 管理者 array[オブジェクト]
  
  管理者は、組織の OG_ADMIN を一覧表示します。プラットフォーム管理者リストのみが入力されています。ノード向け組織のエンドポイントでは省略されます。
  
  管理属性を非表示にする管理者属性の表示オブジェクト
  
  メールアドレス string
  
  name string
- atlas オブジェクト
  
  Atlas 属性の非表示 Atlas 属性の表示オブジェクト
  
  environment string 必須
  
  id string 必須
- created_at string
- 説明 string
- id string
- name string
- ソース string
  
  値は atlas または agent_engine です。
- Updated_at string
応答属性の非表示応答属性の表示オブジェクト
- 管理者 array[オブジェクト]
  
  管理者は、組織の OG_ADMIN を一覧表示します。プラットフォーム管理者リストのみが入力されています。ノード向け組織のエンドポイントでは省略されます。
  
  管理属性を非表示にする管理者属性の表示オブジェクト
  
  メールアドレス string
  
  name string
- atlas オブジェクト
  
  Atlas 属性の非表示 Atlas 属性の表示オブジェクト
  
  environment string 必須
  
  id string 必須
- created_at string
- 説明 string
- id string
- name string
- ソース string
  
  値は atlas または agent_engine です。
- Updated_at string
400

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

無効なリクエスト
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値
404

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

見つかりません
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値
500

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

内部サーバーエラー
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値

PUT /api/v1 /organizations/{id}

curl \
 --request PUT 'https://agentengine.mongodb.com/api/v1/organizations/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "description": "string",
  "name": "string"
}'

リクエスト例

{
  "description": "string",
  "name": "string"
}

応答の例（406）

{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

応答の例（406）

{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

応答の例（200）

{
  "admins": [
    {
      "email": "string",
      "name": "string"
    }
  ],
  "atlas": {
    "environment": "string",
    "id": "string"
  },
  "created_at": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "source": "atlas",
  "updated_at": "string"
}

応答の例（200）

{
  "admins": [
    {
      "email": "string",
      "name": "string"
    }
  ],
  "atlas": {
    "environment": "string",
    "id": "string"
  },
  "created_at": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "source": "atlas",
  "updated_at": "string"
}

応答の例（400）

{
  "code": "string",
  "error": "string",
  "success": true
}

応答の例（400）

{
  "code": "string",
  "error": "string",
  "success": true
}

応答の例（404）

{
  "code": "string",
  "error": "string",
  "success": true
}

応答の例（404）

{
  "code": "string",
  "error": "string",
  "success": true
}

応答の例（500）

{
  "code": "string",
  "error": "string",
  "success": true
}

応答の例（500）

{
  "code": "string",
  "error": "string",
  "success": true
}