如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题

API 组织访问限制

限制用户可以从您的网络访问哪些 API 组织。

通过 API 组织访问限制,您可以控制用户从您的网络访问哪些 API 组织。请通过代理或安全访问服务边缘(SASE)服务配置组织 ID 允许列表。

工作原理

  • 自定义允许列表请求头:在网络配置中添加自定义 HTTP 请求头 OpenAI-Allowed-Organization-Ids,指定允许访问的 API 组织。您可以在请求头中填写一个或多个组织 ID(例如 org-…)。多个 ID 之间用英文逗号分隔,不加空格。
  • API 平台按允许列表控制访问:
    • 当用户从您的网络登录 API 平台时,OpenAI 会读取请求头,检查用户尝试访问的 API 组织的 ID 是否列在 OpenAI-Allowed-Organization-Ids 请求头中。
    • 如果用户尝试访问请求头中未列出的组织,OpenAI 会自动拒绝该请求并返回状态码为 403 的错误,从而阻止用户访问该组织。用户只能访问请求头中列出的组织。

配置

第 1 步:查找组织 ID

要允许用户访问特定组织,请逐一复制这些组织的组织 ID。您可以在 API 平台的组织设置页面找到组织 ID:

  • 登录您的 API 平台账户,切换到要允许访问的组织。
  • 打开组织设置页面,记下组织 ID(例如 org-Tkxfm8owx4zIPaJGNDVrPs6m)。

第 2 步:配置请求头

请通过代理或安全访问服务边缘(SASE)服务配置您的网络,使其发送该请求头。

  • 要允许访问多个组织,请填写各组织的组织 ID,用英文逗号分隔,不加空格。
  • 指定目标 URL:
    • 配置代理或 SASE 服务,使其仅对发往 https://api.openai.com/* 的请求添加该请求头。

第 3 步:验证配置

配置请求头后,请将测试设备连接到该规则适用的网络,并在设备上测试访问情况。

  1. 使用能够访问以下两类组织的账户登录 API 平台:
    • 允许列表中的一个组织。
    • 允许列表之外的一个组织。
  2. 打开允许列表中的组织,确认您可以访问该组织。
  3. 尝试打开允许列表之外的组织,确认访问被阻止,且返回的错误状态码为 403。
  4. 如果您允许访问多个组织,请逐一确认您可以访问这些组织。

如果测试结果与预期不符,请检查代理或 SASE 规则是否适用于测试设备,以及请求头中的组织 ID 是否正确。

排查访问错误

  • 状态码 403:如果用户尝试访问未获准访问的 API 组织,就会看到状态码为 403 的错误。错误消息会提示用户无权访问该组织。
  • 状态码 400:如果请求头的值格式有误(例如组织 ID 无效),所有携带该请求头的请求都会失败,并返回状态码为 400 的错误。