gateway.yaml. El archivo define todo lo que hace la puerta de enlace: dónde escucha, cómo inician sesión los desarrolladores, dónde va la inferencia y qué políticas y telemetría se aplican. Esta página es la referencia para cada opción en ese archivo. Para escribir el primero, comience desde el inicio rápido, que construye una configuración mínima funcional y la ejecuta; una vez que tenga una configuración con la que esté satisfecho, la guía de implementación cubre la containerización y el alojamiento en Kubernetes, Cloud Run o su propia plataforma.
La puerta de enlace lee el archivo una vez, al iniciar, con claude gateway --config /path/to/gateway.yaml. Cada opción se valida contra un esquema al arrancar, por lo que una configuración mal formada falla al iniciar con un error a nivel de campo en lugar de en el primer uso.
El ejemplo completo al final de esta página ejercita cada sección.
Estructura del archivo
Cinco secciones son requeridas. Todas las demás secciones son opcionales, y una sección omitida toma sus valores predeterminados. Las claves desconocidas fallan al arrancar, por lo que un error tipográfico aparece como un error nombrado en lugar de una configuración silenciosamente ignorada. Secciones requeridas:listen: dirección de enlace, URL pública, terminación TLSoidc: su proveedor de identidad (IdP), incluido emisor, cliente, mapeo de reclamaciones y quién puede iniciar sesiónsession: los tokens portadores que emite la puerta de enlace, con secreto y duraciónstore: PostgreSQL, para concesiones de dispositivos y contadores de límite de velocidadupstreams: dónde va la inferencia, ya sea Anthropic, Bedrock, Agent Platform o Foundry
admin: autenticación de API de administración y retención de límites de gastoenforcement: comportamiento de límite de gasto de fallo abierto o fallo cerradomodelsyauto_include_builtin_models: lista de modelos curada por administrador e IDs por upstreammanaged: políticas de configuración administradas por grupo de IdPtelemetry: reenvío OTLP a su pila de observabilidadaccess_control,limits,timeouts,rate_limits: permitir/denegar IP, límites de tamaño de solicitud, tiempo hasta el primer byte del upstream y límites de inicio de sesión por IP
Expansión de secretos
No escriba secretos comoclient_secret, jwt_secret o postgres_url directamente en gateway.yaml. Haga referencia a ellos con uno de los formularios a continuación, y la puerta de enlace resuelve el valor al arrancar desde una variable de entorno o un archivo:
| Formulario | Se resuelve a | Usar para |
|---|---|---|
${VAR} | La variable de entorno VAR. El arranque falla si no está definida. | Variables de entorno de contenedor, AWS Secrets Manager mediante inyección de env |
${file:/path} | Contenido del archivo, recortado | Montajes de volumen de secreto de Kubernetes, Vault Agent, SOPS |
Secciones requeridas
listen
El bloque listen controla dónde sirve la puerta de enlace: la dirección de enlace y puerto, el origen visible externamente y la terminación TLS opcional.
| Campo | Requerido | Descripción |
|---|---|---|
host | No | Dirección de enlace. Predeterminado 0.0.0.0. |
port | No | Puerto de enlace. Predeterminado 8080. |
public_url | Detrás de un proxy | El origen https:// visible externamente, utilizado para construir el redirect_uri de IdP y metadatos de descubrimiento. Requerido detrás de cualquier proxy que termine TLS como ALB, Ingress o Cloud Run, porque la puerta de enlace no confía en los encabezados X-Forwarded-* al construir su propio origen; son suplantables por el cliente. trusted_proxies a continuación rige solo la resolución de IP del cliente. También es necesario para habilitar telemetría, porque la puerta de enlace construye el punto final OTLP que envía a los clientes desde esta URL. |
tls.cert / tls.key | No | Rutas PEM si la puerta de enlace termina TLS por sí misma |
trusted_proxies | No | CIDR o IPs de equilibradores de carga frente a la puerta de enlace. Cuando se establece, la puerta de enlace confía en X-Forwarded-For solo desde estos pares y registra la IP del cliente real para límites de velocidad por IP y auditoría. Equivalente a nginx set_real_ip_from. |
oidc
OpenID Connect (OIDC) es el protocolo SSO que la puerta de enlace utiliza con su proveedor de identidad; consulte Configuración del proveedor de identidad para saber qué registrar en el lado de IdP. El bloque oidc conecta la puerta de enlace a su proveedor de identidad y decide quién puede iniciar sesión. Nombra el emisor y cliente OAuth, mapea las reclamaciones que llevan correo electrónico y grupos, y restringe el inicio de sesión por dominio de correo electrónico o grupo.
| Campo | Requerido | Descripción |
|---|---|---|
issuer | Sí | Base de descubrimiento OIDC. Debe servir descubrimiento en /.well-known/openid-configuration. Use HTTPS en producción; la puerta de enlace acepta un emisor http://. Un emisor de bucle local como http://localhost:8081 es rechazado por la protección SSRF a menos que CLAUDE_GATEWAY_ALLOW_LOOPBACK=1 esté establecido en el entorno de la puerta de enlace. |
client_id / client_secret | Sí | De su registro de cliente OAuth |
allowed_email_domains | No | Rechace id_tokens cuya reclamación email no esté en uno de estos dominios, sin distinción de mayúsculas y minúsculas. Defensa en profundidad contra configuración errónea de IdP multiinquilino. Independientemente de esta configuración, un id_token cuya reclamación email_verified es explícitamente false siempre se rechaza. |
allowed_groups | No | Restrinja el inicio de sesión a miembros de estos grupos de IdP, comparados contra groups_claim. Un usuario en un dominio de correo electrónico permitido pero en ninguno de estos grupos es rechazado. Requiere que IdP emita la reclamación de grupos. |
groups_claim | No | Qué reclamación de id_token lleva la membresía del grupo. Predeterminado groups. Microsoft Entra emite roles de aplicación bajo roles. Acepta una clave plana o un puntero JSON RFC 6901 como /resource_access/gateway/roles para reclamaciones anidadas. |
google_groups | No | Busque los grupos del usuario que inició sesión a través de la API del Directorio del SDK de administración de Google Workspace, porque el id_token de Google no lleva reclamación de grupos. Establezca service_account_json_path en un archivo de clave de cuenta de servicio con delegación en todo el dominio en el alcance https://www.googleapis.com/auth/admin.directory.group.readonly, y admin_email en un administrador de Workspace que la cuenta de servicio suplanta; la API del Directorio requiere un asunto administrador real. Las direcciones de correo electrónico del grupo de cada usuario se convierten en su reclamación de grupos, por lo que allowed_groups y managed.policies.match.groups coinciden en correos electrónicos de grupo. |
email_claim | No | Qué reclamación de id_token lleva el correo electrónico del usuario. Predeterminado email. Algunos IdP, como ADFS y Entra B2C, emiten upn o preferred_username en su lugar. Acepta una clave plana, un puntero JSON o una lista de claves de respaldo donde se utiliza la primera clave presente. |
scopes | No | Anulación completa de los alcances OIDC que solicita la puerta de enlace. Predeterminado [openid, profile, email, offline_access]. Establezca cuando su IdP rechace alcances que no reconoce, o requiera un alcance personalizado para emitir grupos o correo electrónico. Debe incluir openid. Soltar offline_access desactiva los tokens de actualización, por lo que los desarrolladores vuelven a ejecutar el inicio de sesión del navegador cada session.ttl_hours. Consulte Configuración del proveedor de identidad para recetas de alcance por IdP como el flujo de token de actualización de Google. |
extra_auth_params | No | Parámetros de consulta adicionales añadidos a la solicitud de autorización de IdP, textualmente. Este es el mecanismo de anulación para comportamiento específico de IdP, como access_type: offline para tokens de actualización de Google, domain_hint para algunos inquilinos de Entra, o acr_values para flujos de escalada. No puede anular los parámetros de protocolo administrados por la puerta de enlace: state, nonce, redirect_uri, PKCE, scope, response_type, response_mode y client_id. |
userinfo_fallback | No | Cuando el id_token omite correo electrónico o grupos, búsquelos en /userinfo. Necesario para tokens de acceso ligeros de Keycloak, el servidor org de Okta y tokens mínimos de ADFS. El id_token sigue siendo autoritario; userinfo solo llena vacíos. Predeterminado false. |
use_pkce | No | Envíe un desafío PKCE (S256) en la solicitud de autorización. Predeterminado true. Establezca false solo si su IdP rechaza PKCE para este cliente confidencial. |
clock_skew_seconds | No | Tolere la desviación del reloj al validar reclamaciones de tiempo de id_token. Predeterminado 0, que es estricto. Aumente si ve errores “token expirado / aún no válido” justo después del inicio de sesión debido a desviación del reloj de host/IdP. |
token_endpoint_auth_method | No | Anule el método de autenticación del punto final del token. Acepta client_secret_basic o client_secret_post. Negociado automáticamente de forma predeterminada. |
id_token_signed_response_alg | No | Algoritmo de firma de id_token esperado. Predeterminado RS256. Establezca para IdP que firman con ES256, PS256 o EdDSA. |
additional_authorized_parties | No | Valores azp adicionales para aceptar más allá de client_id, para flujos de intermediario de Keycloak e intercambio de tokens |
discovery_url | No | Busque el documento de descubrimiento desde esta URL en lugar de derivarlo de issuer, para IdP detrás de un proxy que reescribe el host del emisor. La ruta debe contener /.well-known/. |
form_action_origins | No | Orígenes adicionales para la directiva Content-Security-Policy: form-action de la página /device. La puerta de enlace ya permite 'self' y el origen authorization_endpoint descubierto, pero Chrome aplica form-action contra toda la cadena de redirección. Si su IdP redirige a través de un segundo host, como Azure AD federado a ADFS, Okta de concentrador y radio, o un interceptor SSO corporativo, enumere cada origen por el que la solicitud de autorización puede redirigir. |
ca_cert_pem | No | Certificado CA PEM que reemplaza el almacén de confianza del sistema solo para solicitudes de IdP. Úselo para Keycloak o Dex detrás de PKI corporativa. |
session
El bloque session forma los tokens portadores que emite la puerta de enlace después del inicio de sesión: el secreto que los firma y cuánto tiempo viven.
| Campo | Requerido | Descripción |
|---|---|---|
jwt_secret | Sí | Al menos 32 bytes de entropía, por ejemplo de openssl rand -base64 32. Firma los tokens portadores HS256 de la puerta de enlace. Acepta una cadena única o una matriz para rotación: el índice 0 firma y todas las entradas verifican. Para rotar, anteponga un nuevo secreto, espere ttl_hours, luego suelte el antiguo. |
ttl_hours | No | Duración del token portador de la puerta de enlace. Predeterminado 1. El CLI se actualiza silenciosamente antes de la expiración cuando IdP emite tokens de actualización. Una duración más corta desactiva más rápido; una más larga hace menos viajes de IdP. Si su IdP no puede emitir tokens de actualización porque offline_access no está disponible, no hay actualización silenciosa, así que aumente esto a 8 o 12 para evitar enviar desarrolladores de vuelta al inicio de sesión del navegador cada hora. |
store
El bloque store apunta la puerta de enlace a su base de datos PostgreSQL, que contiene concesiones de dispositivos y contadores de límite de velocidad.
| Campo | Requerido | Descripción |
|---|---|---|
postgres_url | Sí | URL postgres:// o postgresql://. Requerido: el encuentro de concesión de dispositivo, donde la devolución del navegador escribe y el CLI de sondeo lee, necesita estado entre réplicas. La puerta de enlace ejecuta sus propias migraciones de esquema al arrancar, por lo que el rol necesita CREATE TABLE en el esquema de destino. Si su política de seguridad prohíbe DDL desde el rol de aplicación, ejecute las migraciones con un rol de administrador, inicialmente y nuevamente cada vez que una nueva versión envíe migraciones, y otorgue al rol de aplicación SELECT, INSERT, UPDATE, DELETE en las tablas de la puerta de enlace. Consulte Actualizaciones y Postgres. |
username | No | Anula el usuario en postgres_url |
password | No | Credencial de base de datos. Establézcalo aquí en lugar de en postgres_url para que la credencial se mantenga fuera de la URL. Acepta cualquier carácter y tiene prioridad sobre las credenciales de URL. |
max_connections | No | Tamaño del grupo de conexiones de Postgres por réplica. Predeterminado 5, que es conservador y amigable con bases de datos compartidas. Con límites de gasto habilitados, la ruta activa realiza algunas operaciones por solicitud de inferencia, así que aumente para una base de datos dedicada bajo carga, y mantenga réplicas × esto por debajo de max_connections de la base de datos. |
postgres_url a un contenedor Postgres desechable, por ejemplo docker run --rm -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust postgres.
upstreams
upstreams es una lista ordenada. La puerta de enlace reenvía la inferencia al primer upstream que resuelve el modelo solicitado. En 5xx, 429 o tiempo de espera, falla al siguiente; otros 4xx no, porque esos errores son atribuibles a la solicitud en lugar del upstream. Múltiples upstreams del mismo proveedor deben establecer un name: distinto.
Los clientes de Bedrock, Agent Platform y Foundry se construyen una vez al iniciar, y sus SDK actualizan credenciales internamente, por lo que rotar credenciales en la nube no requiere un reinicio. Las claves API estáticas de Anthropic y los portadores se leen al iniciar; consulte API de Anthropic.
API de Anthropic
El upstream mínimo de Anthropic es una clave API de la Consola Claude:api_key: envíax-api-key. Rótelo en la Consola Claude y actualice la variable env.oauth_token: envíaAuthorization: Bearer. Use la forma de portador cuando su organización emita tokens de corta duración en lugar de claves API de larga duración. El portador se lee una vez al iniciar, así que actualice remontando el secreto e reiniciando.
Amazon Bedrock
Para la implementación de Bedrock del lado del cliente que la puerta de enlace reemplaza o enfrenta, consulte Claude Code en Amazon Bedrock. El upstream del lado de la puerta de enlace:auth vacío utiliza la cadena de credenciales predeterminada del SDK de AWS: variables env, ~/.aws/credentials, rol de tarea de ECS, metadatos de instancia de EC2 o IRSA en EKS. En producción, otorgue a la vaina de la puerta de enlace un rol de IAM en lugar de incrustar claves estáticas en una imagen de contenedor.
| Configuración | Cómo |
|---|---|
| Permisos de IAM | Otorgue al principal de la puerta de enlace bedrock:InvokeModel y bedrock:InvokeModelWithResponseStream tanto en los ARN de perfil de inferencia como en los ARN de modelo de fundación subyacentes. Para el catálogo integrado en regiones de EE.UU.: arn:aws:bedrock:<region>:<account>:inference-profile/us.anthropic.* y arn:aws:bedrock:*::foundation-model/anthropic.*. |
| Acceso a modelos | En la consola de Bedrock, por región, solicite y habilite el acceso a modelos para los modelos Claude que desee. Los perfiles de inferencia entre regiones (us.anthropic.*) requieren acceso a modelos en cada región que abarca el perfil. |
| EKS (IRSA) | Cree un rol de IAM con la política anterior y una política de confianza para el proveedor OIDC de su clúster limitado a la cuenta de servicio de la puerta de enlace. Anote la cuenta de servicio con eks.amazonaws.com/role-arn: arn:aws:iam::<acct>:role/claude-gateway. auth: {} la recoge. |
| ECS / EC2 | Adjunte el rol de IAM a la definición de tarea o perfil de instancia. auth: {} la recoge. |
| En cualquier otro lugar | Pase credenciales a través de las variables env AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY y AWS_SESSION_TOKEN, o establézcalas explícitamente en auth: con expansión ${VAR} |
| Región | region: es la región del punto final de API. Los perfiles de inferencia entre regiones enrutan a través de la geografía (EE.UU., UE, APAC) independientemente de cuál elija. Para regiones no estadounidenses o ARN de rendimiento aprovisionado, agregue un bloque models: con los IDs correctos por upstream. |
Plataforma de agentes de Google Cloud
Para la configuración equivalente del lado del cliente, consulte Claude Code en Google Cloud. El upstream del lado de la puerta de enlace:auth vacío utiliza Credenciales predeterminadas de aplicación: GOOGLE_APPLICATION_CREDENTIALS, metadatos de GCE o Workload Identity de GKE. Los archivos de clave JSON de cuenta de servicio son compatibles pero desaconsejados; use Workload Identity o adjunte una cuenta de servicio a la instancia de GCE o Cloud Run.
Establezca region: global para usar el punto final global de Agent Platform en lugar de uno regional. Google luego enruta cada solicitud a una región disponible, por lo que no rastrea la disponibilidad de modelos por región. Establecer una región específica fija cada solicitud a ella.
| Configuración | Cómo |
|---|---|
| Permisos de IAM | Otorgue a la cuenta de servicio de la puerta de enlace roles/aiplatform.user en el proyecto, o un rol personalizado con aiplatform.endpoints.predict. Habilite la API de Agent Platform (aiplatform.googleapis.com). |
| Acceso a modelos | En Model Garden, habilite los modelos Claude para su proyecto. Se publican en regiones específicas; consulte la tarjeta del modelo para regiones compatibles. |
| GKE (Workload Identity) | Vincule una cuenta de servicio de GCP a la cuenta de servicio de Kubernetes de la puerta de enlace y anote la KSA con iam.gke.io/gcp-service-account: claude-gateway@<proj>.iam.gserviceaccount.com. auth: {} la recoge. |
| Cloud Run / GCE | Establezca la cuenta de servicio del servicio en una con roles/aiplatform.user. auth: {} la recoge. |
| En cualquier otro lugar | auth: { service_account_json: /secrets/sa.json }, la ruta a un archivo de clave JSON montado como secreto. El campo toma una ruta de archivo, no el contenido de la clave, por lo que no hay expansión ${file:…} involucrada. |
Microsoft Foundry
Para la implementación de Foundry del lado del cliente, consulte Claude Code en Microsoft Foundry. El upstream del lado de la puerta de enlace:use_azure_ad: true se resuelve a través de DefaultAzureCredential: Managed Identity en AKS, ACI o App Service; la CLI de Azure; o credenciales de entorno. Las claves API funcionan pero son amplias del proyecto y no se rotan automáticamente. El punto final de Foundry se deriva de resource:; establezca el base_url opcional para anularlo para nubes soberanas como Azure Government.
| Configuración | Cómo |
|---|---|
| RBAC | Otorgue a la identidad de la puerta de enlace Azure AI User o Cognitive Services User en el recurso de Foundry |
| Implementaciones | Foundry utiliza nombres de implementación elegidos por administrador, no IDs de modelo canónicos. Agregue un bloque models: que asigne cada ID canónico a su nombre de implementación. |
| AKS (workload identity) | Federe una Managed Identity asignada por el usuario con el emisor OIDC del clúster y vincúlela a la cuenta de servicio de la puerta de enlace. use_azure_ad: true la recoge a través de WorkloadIdentityCredential. |
| ACI / App Service | Habilite la identidad administrada asignada por el sistema o por el usuario en el recurso. use_azure_ad: true la recoge. |
| En cualquier otro lugar | auth: { api_key: "${FOUNDRY_API_KEY}" }. Entrecomille ${…} dentro de { }. |
Múltiples upstreams
El mismo proveedor puede aparecer más de una vez con unname: distinto. Esto cubre diferentes regiones, diferentes cuentas a través de diferentes cadenas de credenciales, rendimiento aprovisionado versus bajo demanda, y conmutación por error entre proveedores.
La puerta de enlace intenta upstreams en orden. 5xx, 429, tiempos de espera y punto final faltante (501) conmutan por error; otros 4xx no. 429 es capacidad por upstream, por lo que el agotamiento de rendimiento aprovisionado (PT) conmuta por error a bajo demanda. Un upstream que no puede resolver el modelo solicitado se omite sin un viaje de red.
Este ejemplo enruta una asignación de rendimiento aprovisionado de Bedrock primero, desborda a bajo demanda y una segunda cuenta, y vuelve a la API de Anthropic al final:
| Palanca | Cómo |
|---|---|
| Diferentes regiones | Un upstream de Bedrock por región, cada uno con su propio region:. Con auto_include_builtin_models: true los perfiles de inferencia entre regiones enrutan automáticamente; para implementaciones fijas de región use un bloque models:. |
| Diferentes cuentas | Un upstream de Bedrock por cuenta, cada uno con sus propias credenciales en auth:. La cadena predeterminada (auth: {}) utiliza la identidad de la vaina; para una segunda cuenta, establezca credenciales explícitas o un token portador. |
| Rendimiento aprovisionado | Asigne el modelo al ARN de rendimiento aprovisionado en models: para el nombre de ese upstream. Otros upstreams mantienen el ID bajo demanda, por lo que la capacidad de PT se agota antes de conmutar por error. |
| Puntos finales de VPC / FIPS | Establezca base_url: en el upstream a su URL de punto final de VPC o FIPS |
| Enrutamiento limitado a modelo | Omita un upstream del mapa upstream_model: de un modelo y ese upstream se omite para ese modelo. Por ejemplo, enrute Opus a rendimiento aprovisionado y Sonnet y Haiku a bajo demanda. |
Secciones opcionales
admin
Opcional. Habilita /v1/organizations/spend_limits, que refleja la API de administración pública de Anthropic, y cumplimiento de gasto por desarrollador en /v1/messages. Consulte Límites de gasto para saber cómo se establecen y aplican los límites; esta sección cubre las claves gateway.yaml que activan la función y la ajustan.
| Campo | Requerido | Descripción |
|---|---|---|
write_keys | No | Matriz de {id, key}. Un x-api-key que coincida con uno de estos puede listar, establecer y eliminar límites de gasto. Los valores de clave deben tener al menos 32 caracteres; los ids deben ser únicos en read_keys y write_keys. |
read_keys | No | Matriz de {id, key}. Solo lectura: cada punto final GET, incluida la enumeración de límites, la obtención de uno por ID y la lectura de /effective y /audit. |
admin_groups | No | Nombres de grupos de IdP. Un JWT de puerta de enlace cuya reclamación groups incluye uno de estos tiene acceso de administrador completo, lectura y escritura, y audita como oidc:<sub>. Úselo para administradores humanos; use claves API para máquinas. |
blocked_message | No | Añadido textualmente al 429 billing_error que ve un desarrollador bloqueado. Escriba la instrucción completa, como una URL o un canal de Slack. Sin establecer, el error es spend limit reached. |
audit_retention_days | No | Predeterminado 365. Las filas admin_audit más antiguas se barren. |
spend_retention_months | No | Predeterminado 13. Las filas del contador spend más antiguas que esto se barren. El predeterminado mantiene un año completo más el mes parcial actual para informes año a año. |
identity_retention_days | No | Predeterminado 90. TTL de última visualización para filas principal_emails, que contienen el correo electrónico, nombre para mostrar y grupos de cada desarrollador (PII). Deliberadamente más corto que la retención de gasto para que una identidad desaprovisionada envejecida mientras sus contadores de gasto anónimos permanecen. |
group_limit_mode | No | min (predeterminado) o max. Cuando un desarrollador está en varios grupos con límites, min aplica el más restrictivo y max el menos. Utilizado tanto por cumplimiento como por /effective. |
enforcement
El bloque enforcement controla cómo se comportan las verificaciones de límite de gasto cuando el almacén no está disponible.
| Campo | Requerido | Descripción |
|---|---|---|
fail_closed_on_error | No | Predeterminado false. El cumplimiento de gasto falla abierto en una interrupción de Postgres, por lo que la inferencia permanece activa. Establezca true para fallar cerrado: los desarrolladores sobre el límite se bloquean, pero también todos si el almacén es inaccesible. No tiene efecto sin un bloque admin:. |
models
El bloque models es una lista de modelos curada por administrador opcional, servida en /v1/models y utilizada para traducir IDs de modelo por upstream. Es necesario para regiones de Bedrock no estadounidenses, ARN de rendimiento aprovisionado de Bedrock y nombres de implementación de Foundry.
managed
El bloque managed define políticas de acceso basadas en roles clave en grupos de IdP o dominio de correo electrónico. Las políticas se evalúan en orden; se selecciona la primera coincidencia, luego se fusiona en la base de captura match: {} descrita a continuación. Se sirven por usuario en GET /managed/settings con almacenamiento en caché de ETag/304.
match: {}, convencionalmente listada al final, se trata como una capa base. Cada otra política hereda cualquier clave que no establezca de la captura, por lo que las entradas por rol solo necesitan listar lo que difiere del predeterminado de la organización. Las reglas de fusión dependen del tipo de clave:
- Listas de permitidos:
availableModelsypermissions.allow. La lista de una política específica reemplaza completamente la de la base. - Listas de denegación y matrices de hooks:
permissions.deny,permissions.ask,disabledMcpjsonServers,deniedMcpServers,blockedMarketplacesy cada matriz de tipo de eventohooks. Estos toman la unión de base y política, por lo que un gancho de denegación o auditoría en toda la organización no puede ser accidentalmente eliminado por una anulación por rol. - Claves de tipo registro:
env,modelOverridesyskillOverrides. Estos se fusionan superficialmente, por lo que un bloqueenvpor rol anula las claves que establece y hereda el resto de la base.
availableModels también se aplica del lado del servidor en /v1/messages, por lo que un modelo denegado devuelve 400 independientemente de lo que envíe el cliente.
| Coincidencia | Comportamiento |
|---|---|
match: {} | Coincide con cada usuario autenticado. Comience con uno de estos y agregue políticas limitadas a grupo más tarde. |
match: { groups: [a, b] } | Coincide si la reclamación groups del JWT contiene cualquiera de los grupos listados. Sensible a mayúsculas y minúsculas: los grupos deben coincidir con el uso exacto de mayúsculas y minúsculas de IdP. |
match: { email_domain: example.com } | Coincide con la parte después de la última @ en la reclamación email del JWT, sin distinción de mayúsculas y minúsculas. Acepta un dominio por política. |
match: { groups: [a], email_domain: example.com } | Ambas condiciones deben coincidir |
match: {} al final si desea una política predeterminada garantizada.
La puerta de enlace no mantiene su propio directorio de usuarios. Autoriza cada solicitud desde el token de IdP del usuario, leyendo la membresía del grupo de la reclamación
groups del token y evaluando políticas contra ella. No hay un registro para enumerar y no hay cuentas para crear previamente, y por lo tanto no hay punto final SCIM, porque no hay nada para que SCIM sincronice.Ejecute la gestión del ciclo de vida del usuario y grupo en la fuente de verdad, que es el aprovisionamiento SCIM nativo de su IdP o una plataforma de gobernanza de identidad dedicada. La membresía y desaprovisionamiento gobernados allí fluyen a la puerta de enlace automáticamente a través del token. Si desea el aprovisionamiento SCIM de las propias cuentas de Claude, esa es una capacidad de Claude para empresas.Se aplican dos relojes de propagación:- Contenido de política: editar una política e implementar nuevamente llega a clientes conectados en su próxima encuesta de configuración administrada, dentro de una hora
- Membresía de grupo: cambiar la membresía de grupo de un usuario cambia qué política los coincide. Esto entra en vigor en la siguiente acuñación de sesión, lo que significa la siguiente actualización silenciosa, limitada por
session.ttl_hours.
Qué va en cli
Cada valor cli es un documento completo de managed-settings.json de Claude Code, el mismo esquema que implementaría a través de MDM o /etc/claude-code/managed-settings.json, expresado aquí como YAML. El CLI aplica el documento entregado en el nivel administrado, por encima de la configuración de usuario y proyecto.
La puerta de enlace valida cada documento contra el esquema de configuración del CLI al arrancar, por lo que una clave de nivel superior no reconocida o una clave reconocida con un valor mal formado falla al arrancar con un error que nombra cada clave ofensiva. Las partes deliberadamente abiertas del esquema aún aceptan valores arbitrarios, porque clientes más nuevos pueden reconocer entradas que el esquema de la puerta de enlace no. Estas claves abiertas son env, pluginConfigs y claves anidadas bajo permissions.
Debido a que la validación utiliza el esquema incluido con la versión instalada de la puerta de enlace, poner una clave de configuración de nivel superior introducida por una versión más nueva de Claude Code en la configuración administrada requiere actualizar primero la puerta de enlace. Pruebe una nueva política en un cliente antes de implementarla ampliamente.
La referencia de clave completa está en Configuración de Claude Code. Las claves que los operadores alcanzan primero:
| Clave | Aplicada por | Efecto |
|---|---|---|
availableModels | Puerta de enlace + CLI | Lista de permitidos de modelos. También se verifica en /v1/messages, por lo que un cliente parcheado no puede omitirlo. |
permissions.allow / .deny | CLI | Reglas de herramientas y comandos. Consulte Permisos. |
permissions.disableBypassPermissionsMode | CLI | Establezca en disable para bloquear bypassPermissions, el modo que aprueba automáticamente cada llamada de herramienta, y la bandera --dangerously-skip-permissions |
allowManagedPermissionRulesOnly | CLI | Cuando es true, se ignoran las reglas de permisos de usuario y proyecto; solo se aplican las reglas de este documento |
env | CLI | Variables de entorno fusionadas en el proceso CLI. Úselo para telemetría, actualización automática y anulaciones de nombres de modelos. |
hooks | CLI | Hooks en toda la organización |
hooks- Variables
envque no están en la lista segura integrada del CLI - Configuración de ejecución de shell como
apiKeyHelperystatusLine - Contenido de CLAUDE.md administrado
env se aplican sin aprobación:
- En la lista segura: variables de actualización automática y nombre de modelo
- No en la lista segura: variables de proxy, variables de URL base y
OTEL_EXPORTER_OTLP_ENDPOINT
OTEL_EXPORTER_OTLP_ENDPOINT, por lo que establecer telemetry.forward_to desencadena el diálogo en cada cliente interactivo. Las ejecuciones no interactivas con la bandera -p omiten el diálogo y aplican configuración sin aprobación. El diálogo protege la máquina del desarrollador de una puerta de enlace comprometida u hostil, no la organización del desarrollador, por lo que el salto -p es intencional en lugar de una brecha.
Si un desarrollador rechaza, Claude Code sale en lugar de aplicar la política. Empujar un nuevo gancho o variable env no segura a una política amplia significa un mensaje de aprobación en el próximo inicio de cada desarrollador coincidente.
La clave cli se nombró settings en versiones anteriores. Ese deletreo aún se acepta como alias, pero las nuevas implementaciones deben usar cli.
Precedencia con otras fuentes administradas
Si un dispositivo también tiene unmanaged-settings.json local o una política entregada por MDM, las fuentes administradas no se fusionan. La fuente de mayor prioridad proporciona toda la configuración de política, clasificada en este orden con mayor prioridad primero:
- El asistente de política
- Configuración entregada por puerta de enlace
- MDM, a través del registro HKLM en Windows o un plist en macOS
- El archivo
managed-settings.json - El registro HKCU, solo en Windows
managedSettings del SDK. Se ignora de forma predeterminada y se aplica solo cuando una fuente administrada se adhiere con parentSettingsBehavior: "merge", filtrada para que pueda endurecer la política pero no aflojarla.
La excepción es un pequeño conjunto de claves entre fuentes, honradas cuando cualquier fuente de administrador las establece; el nivel HKCU escribible por el usuario se excluye:
sandbox.network.allowManagedDomainsOnlyysandbox.filesystem.allowManagedReadPathsOnly: cuando se bloquean, las listas de permitidos correspondientes se unen en todas las fuentesallowAllClaudeAiMcps: anulación de solo permitir para la lista de permitidos del servidor MCP de claude.aisandbox.bwrapPathysandbox.socatPath: rutas del sistema de archivos a los binarios auxiliares de sandbox
allowManagedPermissionRulesOnly y disableBypassPermissionsMode no son entre fuentes, por lo que solo se aplica el valor de la fuente ganadora.
Las políticas de puerta de enlace se aplican a cada invocación de Claude Code en la máquina, incluidas ejecuciones no interactivas claude -p y sesiones generadas por el SDK del agente. Si la puerta de enlace es inaccesible al iniciar, las sesiones firmadas salen con un error en lugar de ejecutarse sin su política.
telemetry
El CLI envía métricas, registros y, cuando está habilitado, trazas del Protocolo OpenTelemetry (OTLP) sobre HTTP a la puerta de enlace, que las retransmite textualmente a cada destino configurado. Consulte Monitoreo de uso para las métricas y eventos que emite el CLI.
El CLI marca cada exportación con la identidad del usuario autenticado, leída del JWT emitido por la puerta de enlace: los atributos user.id, user.email y user.groups. La atribución de costo y uso por desarrollador funciona sin configuración del lado del desarrollador.
telemetry.forward_to junto con listen.public_url la activa. La puerta de enlace empuja cinco variables env a cada cliente conectado a través de /managed/settings:
CLAUDE_CODE_ENABLE_TELEMETRY=1OTEL_METRICS_EXPORTER=otlpOTEL_LOGS_EXPORTER=otlpOTEL_TRACES_EXPORTER=otlpOTEL_EXPORTER_OTLP_ENDPOINT=<public_url>
OTEL_* que un desarrollador establece localmente.
Las trazas además requieren CLAUDE_CODE_ENHANCED_TELEMETRY_BETA=1 en cada cliente. La puerta de enlace no empuja esa variable, así que establézcala a través del bloque env de una política administrada. No está en la lista segura del CLI, por lo que entregarla a través de una política está cubierta por el mismo diálogo de aprobación de seguridad que el punto final OTLP empujado ya desencadena.
Tanto las codificaciones OTLP de protobuf como JSON se retransmiten, y cualquier backend compatible con OpenTelemetry funciona como destino.
Ajuste de HTTP
Cuatro bloques opcionales de nivel superior,access_control, limits, timeouts y rate_limits, ajustan la superficie HTTP. Los valores predeterminados se adaptan a la mayoría de implementaciones.
| Bloque | Clave | Predeterminado | Descripción |
|---|---|---|---|
access_control | allow_cidrs / deny_cidrs | vacío | Permitir/denegar IP de entrada por dirección de cliente, después de la resolución de trusted_proxies. deny_cidrs se verifica primero; un cliente que coincida se rechaza incluso si allow_cidrs también coincide. Si allow_cidrs no está vacío, la puerta de enlace es predeterminada denegada. /healthz y /readyz están exentos de allow_cidrs. |
limits | max_request_bytes | 32 MiB | Cuerpo de solicitud de entrada máximo; las solicitudes de tamaño excesivo obtienen 413 antes de que el cuerpo se almacene en búfer. Aumente para solicitudes de archivo o imagen grandes. |
limits | max_request_header_bytes | sin establecer | Cuando se establece, los encabezados de tamaño excesivo devuelven 431 |
limits | max_url_length | sin establecer | Cuando se establece, una URL demasiado larga devuelve 414 |
timeouts | upstream_ttfb_ms | 120000 | Espera máxima para los encabezados de respuesta del upstream (tiempo hasta el primer byte). El cuerpo de respuesta luego se transmite sin límite de reloj de pared. Se aplica a la ruta de upstream de Anthropic directo; Bedrock, Agent Platform y Foundry están limitados por el tiempo de espera propio del SDK del proveedor. |
rate_limits | device_authorization.max / .window_seconds | 30 / 600 | Límite de velocidad por IP en el punto final de autorización de dispositivo no autenticado. Aumente para una organización grande detrás de una IP de salida compartida o NAT. Estos límites se aplican solo al flujo de inicio de sesión de concesión de dispositivo, no a la inferencia /v1/messages. Consulte Resistencia de fuerza bruta de código de usuario. |
rate_limits | device_verify.max / .window_seconds | 10 / 600 | Límite de velocidad por IP en envíos de user_code en /device |
Ejemplo completo
Esta configuración de referencia completa ejercita cada sección principal; los bloques ajuste de HTTP mantienen sus valores predeterminados. Cópiela, elimine lo que no necesite y complete sus valores. La configuración en el Inicio rápido es una versión mínima de esta.gateway.yaml
Configuración administrada del lado del cliente
Todo lo anterior configura el servidor de puerta de enlace. Apuntar máquinas de desarrollador a él se configura por separado, en cada dispositivo, a través de la configuración administrada de Claude Code. La puerta de enlace no puede empujar estas claves por sí misma, porque son lo que le dice al cliente dónde está la puerta de enlace. Para el CLI, establezca ambas claves en elmanaged-settings.json por SO:
| Plataforma | Ruta |
|---|---|
| macOS | /Library/Application Support/ClaudeCode/managed-settings.json, o el dominio de preferencias administradas com.anthropic.claudecode |
| Linux y WSL | /etc/claude-code/managed-settings.json |
| Windows | C:\Program Files\ClaudeCode\managed-settings.json, o Política de grupo a través del registro HKLM |
forceLoginGatewayUrl y el valor "gateway" de forceLoginMethod se honran solo desde el nivel administrado controlado por administrador. Un desarrollador que los establezca en su propio ~/.claude/settings.json no tiene efecto.
Relacionado
- Descripción general de la puerta de enlace de aplicaciones Claude: inicio rápido y conexión de desarrollador
- Guía de implementación: configuración de IdP, imagen de contenedor, Kubernetes y Cloud Run, y operaciones
- Límites de gasto: límites por desarrollador y la API de administración