Los administradores federales de Enterprise pueden consultar mediante programación el consumo de ACU y gestionar los grupos, la disponibilidad de modelos y los límites de ACU mediante una API con clave de servicio. Un SDK de Python encapsula cada endpoint descrito en esta sección.
Los endpoints de gestión de grupos y de límite de ACU solo están disponibles en despliegues federales autohospedados y multi-tenant. No están disponibles en despliegues comerciales. Los endpoints de análisis (/Analytics, /UserPageAnalytics y /CascadeAnalytics) también verifican el nivel de acceso a análisis del despliegue; un equipo sin acceso a análisis recibe permission_denied.
Todas las solicitudes son de tipo JSON POST al servidor de API de tu despliegue:
Reemplaza <your-server> por el dominio de la API de tu despliegue federal.
Cada solicitud se autentica mediante una clave de servicio incluida en el cuerpo de la solicitud:
Para crear una clave de servicio, inicia sesión en el portal federal como administrador del equipo y ve a Settings → Claves de servicio. Luego, crea una clave con los permisos necesarios para los endpoints que planeas invocar.
Mantén seguras las claves de servicio. Nunca las expongas en código del lado del cliente ni las confirmes en repositorios.
Claves con ámbito de equipo y de grupo
- Las claves con ámbito de equipo pueden consultar datos de todo el equipo y gestionar todos los grupos del equipo.
- Las claves con ámbito de grupo están limitadas al grupo asignado. Pueden leer el total acumulado de ACU y las filas de usuarios del grupo, listar y leer únicamente ese grupo, y leer o actualizar los límites de ACU solo para los miembros actuales de ese grupo. No pueden leer los totales ni las filas de usuarios de todo el equipo, ver otros grupos ni crear grupos.
Las listas de grupos, miembros de grupos y filas de ACU por usuario están paginadas:
page_size — opcional; el valor predeterminado es 100 y el máximo es 1000. Si se omite o se pasa 0, se usa el valor predeterminado.next_page_token — se devuelve cuando hay más resultados. Vuelva a pasarlo como page_token en una solicitud idéntica en todos los demás aspectos (incluido el mismo page_size) para obtener la página siguiente.
Los tokens de página son opacos y están cifrados. Caducan después de 24 horas. Los tokens de consumo de ACU están vinculados al endpoint, el equipo, el ámbito, el período, la selección de grupos y el tamaño de página. Los tokens de las listas de grupos y miembros están vinculados al endpoint, el equipo, el ámbito y el tamaño de página. Cambiar un valor vinculado entre páginas devuelve un error invalid_argument.
Los errores se devuelven en formato JSON con un código y un mensaje:
