Previsualiza el alcance de la política de lista de permitidos de una organización.

publicación /api/v1/organizations/{id}/policies/preview
Autorización del portador

Devuelve los proyectos cuya lista de permitidos efectiva quedaría vacía si se guarda la política de lista de permitidos de la organización especificada, de modo que se advierte al administrador antes de restringir la lista de permitidos de una herramienta o modelo a un conjunto disjunto. Las políticas que no están en la lista de permitidos o que están deshabilitadas no tienen repercusión.

Parámetros de path

  • ID string Requerido

    identificador de la organización

application/json

Cuerpo Requerido

Política organizacional propuesta

  • habilitado booleano

    Indica si la política propuesta se aplicará. Si se omite, el valor predeterminado es verdadero, al igual que en la creación de la política.

  • lista_de_cadenas array[string]
  • tipo string

    Los valores son MAX_TOOL_CALLS_PER_EXECUTION, MAX_LLM_CALLS_PER_EXECUTION, MAX_EXECUTION_DURATION_MS, MAX_TOKENS_PER_EXECUTION, MAX_TOKENS_PER_SESSION, AUTHORIZED_TOOLS o AUTHORIZED_MODELS.

Respuestas

  • 406

    Versión de API no compatible o con formato incorrecto, operación no disponible en el contrato publicado seleccionado o representación inaceptable (incluidos parámetros de tipo de medio no compatibles o SSE excluidos). Los fallos de autenticación, autorización y límite de velocidad existentes tienen prioridad.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.
  • 200

    OK

    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • proyectos_afectados arreglo[objeto]
      Ocultar atributos de affected_projects Mostrar atributos de los proyectos afectados Objeto
      • lista_permitida_actual array[string]
      • project_id string
      • nombre_del_proyecto string
    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • proyectos_afectados arreglo[objeto]
      Ocultar atributos de affected_projects Mostrar atributos de los proyectos afectados Objeto
      • lista_permitida_actual array[string]
      • project_id string
      • nombre_del_proyecto string
  • 400

    Solicitud incorrecta

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 403

    Forbidden

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 500

    Error interno del servidor

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
POST /api/v1/organizations/{id}/policies/preview 
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/organizations/{id}/policies/preview' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "enabled": true,
  "string_list": [
    "string"
  ],
  "type": "MAX_TOOL_CALLS_PER_EXECUTION"
}'
Solicitar ejemplos 
{
  "enabled": true,
  "string_list": [
    "string"
  ],
  "type": "MAX_TOOL_CALLS_PER_EXECUTION"
}
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (200) 
{
  "affected_projects": [
    {
      "current_allowlist": [
        "string"
      ],
      "project_id": "string",
      "project_name": "string"
    }
  ]
}
Ejemplos de respuesta (200) 
{
  "affected_projects": [
    {
      "current_allowlist": [
        "string"
      ],
      "project_id": "string",
      "project_name": "string"
    }
  ]
}
Ejemplos de respuesta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}