更新组织

PUT /api/v1/organizations/{id}

持有者身份验证

更新名称或描述等组织字段。

路径参数

id 字符串必需

组织 ID

application/json

body 必需

要更新的字段

描述字符串
名称字符串

名称在验证之前被修剪。它必须是 1-64 个字符，可以包含 Unicode 字母/数字、空格和字符 - _ 。 ( ) , &; @ + '.

最小长度为 1，最大长度为 64。

响应

406

application/json

application/json 应用程序/vnd.agent-engine-2026-09-20-preview+json

不支持或格式不正确的API版本、所选已发布合约中不可用的操作或不可接受的表示形式（包括不支持的媒体类型参数或排除的 SSE）。现有的身份验证、授权和速率限制失败优先。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  标准错误模式定义的可选验证详细信息； API协商错误不会发出此字段。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  验证失败的字段。
  
  隐藏字段属性显示字段属性对象
  
  字段及其验证失败。
  
  描述字符串必需
  
  人类可读的验证失败。
  
  字段字符串必需
  
  无效请求字段的名称或路径。
- 详细信息字符串必需
  
  人类可读的错误详细信息。
- 错误整型必需
  
  HTTP status code.
- 错误代码字符串必需
  
  机器可读的错误代码。
- 参数 array[string]
  
  与错误相关的请求参数名称；不应用时省略。
- 原因字符串必需
  
  HTTP状态原因短语。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  标准错误模式定义的可选验证详细信息； API协商错误不会发出此字段。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  验证失败的字段。
  
  隐藏字段属性显示字段属性对象
  
  字段及其验证失败。
  
  描述字符串必需
  
  人类可读的验证失败。
  
  字段字符串必需
  
  无效请求字段的名称或路径。
- 详细信息字符串必需
  
  人类可读的错误详细信息。
- 错误整型必需
  
  HTTP status code.
- 错误代码字符串必需
  
  机器可读的错误代码。
- 参数 array[string]
  
  与错误相关的请求参数名称；不应用时省略。
- 原因字符串必需
  
  HTTP状态原因短语。
200

应用程序/vnd.agent-engine-2026-09-20-preview+json

应用程序/vnd.agent-engine-2026-09-20-preview+json application/json

正常
隐藏响应属性显示响应属性对象
- 管理员大量[对象]
  
  Admins（管理员）列出组织的 ORG_ADMIN。仅由平台管理员列表填充；在面向成员的组织端点上省略。
  
  隐藏管理员属性显示管理员属性对象
  
  电子邮件字符串
  
  名称字符串
- atlas 对象
  
  隐藏 Atlas 属性显示 Atlas 属性对象
  
  environment 字符串必需
  
  id 字符串必需
- created_at 字符串
- 描述字符串
- id 字符串
- 名称字符串
- 来源字符串
  
  值为 atlas 或 agent_engine。
- updated_at 字符串
隐藏响应属性显示响应属性对象
- 管理员大量[对象]
  
  Admins（管理员）列出组织的 ORG_ADMIN。仅由平台管理员列表填充；在面向成员的组织端点上省略。
  
  隐藏管理员属性显示管理员属性对象
  
  电子邮件字符串
  
  名称字符串
- atlas 对象
  
  隐藏 Atlas 属性显示 Atlas 属性对象
  
  environment 字符串必需
  
  id 字符串必需
- created_at 字符串
- 描述字符串
- id 字符串
- 名称字符串
- 来源字符串
  
  值为 atlas 或 agent_engine。
- updated_at 字符串
400

application/json

application/json 应用程序/vnd.agent-engine-2026-09-20-preview+json

Bad Request
隐藏响应属性显示响应属性对象
- 代码字符串
- 错误字符串
- Success 布尔
隐藏响应属性显示响应属性对象
- 代码字符串
- 错误字符串
- Success 布尔
404

application/json

application/json 应用程序/vnd.agent-engine-2026-09-20-preview+json

未找到
隐藏响应属性显示响应属性对象
- 代码字符串
- 错误字符串
- Success 布尔
隐藏响应属性显示响应属性对象
- 代码字符串
- 错误字符串
- Success 布尔
500

application/json

application/json 应用程序/vnd.agent-engine-2026-09-20-preview+json

内部服务器错误
隐藏响应属性显示响应属性对象
- 代码字符串
- 错误字符串
- Success 布尔
隐藏响应属性显示响应属性对象
- 代码字符串
- 错误字符串
- Success 布尔

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
}