Get All Groups

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/groups \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "groups": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c25",
      "name": "Engineering Team",
      "description": "Software engineering team",
      "status": "Active",
      "userCount": 15,
      "users": [
        {
          "id": "60a7c8f5e8b4f5001f7a8c24",
          "name": "John Doe",
          "email": "john@example.com"
        }
      ],
      "createdAt": "2024-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "pages": 3
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

GET

groups

Get All Groups

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/groups \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "groups": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c25",
      "name": "Engineering Team",
      "description": "Software engineering team",
      "status": "Active",
      "userCount": 15,
      "users": [
        {
          "id": "60a7c8f5e8b4f5001f7a8c24",
          "name": "John Doe",
          "email": "john@example.com"
        }
      ],
      "createdAt": "2024-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "pages": 3
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

Listar grupos

Recupere una lista de todos los grupos de usuarios en el sistema con opciones de paginación y filtrado.

Endpoint

GET /groups

Descripción

Este endpoint devuelve todos los grupos de usuarios disponibles en el sistema SecureAI. Proporciona información detallada sobre cada grupo, incluidos miembros, permisos y metadatos. Esto es útil para gestionar el acceso de los usuarios y la estructura organizativa.

Autenticación

Requerido: Clave API con privilegios de administrador

Authorization: Bearer sk-your-api-key-here

Parámetros de consulta

Parámetro	Tipo	Requerido	Descripción
`page`	entero	No	1	Número de página para paginación
`limit`	entero	No	20	Número de grupos por página (1-100)
`search`	cadena	No	-	Término de búsqueda para nombre o descripción del grupo
`status`	cadena	No	-	Filtrar por estado del grupo
`sortBy`	cadena	No	creadoEn	Campo para ordenar por
`sortOrder`	cadena	No	desc	Orden de clasificación (asc, desc)

Solicitud de ejemplo

GET /groups?search=engineering&limit=20&page=1&sortBy=createdAt&sortOrder=desc

Respuesta exitosa

Código de estado: 200 OK

{
  "success": true,
  "groups": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c25",
      "name": "Engineering Team",
      "description": "Software engineering and development team",
      "status": "Active",
      "userCount": 15,
      "users": [
        {
          "id": "60a7c8f5e8b4f5001f7a8c24",
          "name": "John Doe",
          "email": "john@example.com"
        }
      ],
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 25,
    "pages": 2
  }
}

Campos de respuesta

Campo	Tipo	Descripción
`success`	booleano	Indica si la operación fue exitosa
`groups[]`	matriz	Matriz de objetos de grupo
`groups[].id`	cadena	Identificador de grupo único
`groups[].name`	cadena	Nombre del grupo
`groups[].description`	cadena	Descripción del grupo
`groups[].status`	cadena	Estado del grupo
`groups[].userCount`	entero	Número de usuarios en el grupo
`groups[].users`	matriz	Matriz de objetos de usuario en el grupo
`groups[].users[].id`	cadena	ID de usuario
`groups[].users[].name`	cadena	Nombre de usuario
`groups[].users[].email`	cadena	Correo electrónico del usuario
`groups[].createdAt`	cadena	Marca de tiempo de creación
`pagination`	objeto	Información de paginación

Ejemplo de uso

JavaScript

const listGroups = async (params = {}) => {
  const queryString = new URLSearchParams(params).toString();
  const url = `https://{customer.name}.hiperai.ai/api/external/groups${queryString ? `?${queryString}` : ''}`;
  
  const response = await fetch(url, {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer sk-your-api-key-here'
    }
  });
  
  return await response.json();
};

// Example usage
const result = await listGroups({
  search: 'engineering',
  limit: 10,
  page: 1,
  sortBy: 'createdAt',
  sortOrder: 'desc'
});
console.log(result.groups);

Pitón

import requests

def list_groups(params=None):
    url = "https://{customer.name}.hiperai.ai/api/external/groups"
    headers = {
        "Authorization": "Bearer sk-your-api-key-here"
    }
    
    response = requests.get(url, headers=headers, params=params)
    return response.json()

# Example usage
params = {
    "search": "engineering",
    "limit": 10,
    "page": 1,
    "sortBy": "createdAt",
    "sortOrder": "desc"
}

result = list_groups(params)
print(result["groups"])

rizo

curl -X GET "https://{customer.name}.hiperai.ai/api/external/groups?search=engineering&limit=10&page=1&sortBy=createdAt&sortOrder=desc" \
  -H "Authorization: Bearer sk-your-api-key-here"

Respuestas de error

401 No autorizado

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

403 Prohibido

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Admin privileges required"
  }
}

429 Demasiadas solicitudes

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "retryAfter": 60
  }
}

Ejemplos de filtrado

Buscar grupos

# Search by name
GET /groups?search=engineering

# Search by description
GET /groups?search=development

Opciones de clasificación

# Sort by name ascending
GET /groups?sortBy=name&sortOrder=asc

# Sort by user count descending
GET /groups?sortBy=userCount&sortOrder=desc

# Sort by creation date
GET /groups?sortBy=createdAt&sortOrder=desc

Paginación

# Get first 20 groups
GET /groups?limit=20&page=1

# Get next 20 groups
GET /groups?limit=20&page=2

Casos de uso

Gestión de grupos: enumera todos los grupos para fines administrativos
Organización de usuarios: descubra los grupos disponibles para la asignación de usuarios
Control de acceso: revisar los permisos del grupo y el recuento de miembros
Informes: genere informes sobre la estructura del grupo y la membresía
Integración: Descubra grupos para la integración de aplicaciones

Límites de tarifas

Predeterminado: 100 solicitudes por minuto
Diario: 10.000 solicitudes por día
Mensual: 300.000 solicitudes por mes

Notas

Solo los administradores pueden acceder a este endpoint.
Paginación: utiliza el parámetro de página, no el desplazamiento.
Respuesta plana: la respuesta no está anidada en el objeto de datos
Detalles del usuario: incluye información de usuario completa para cada miembro del grupo
Filtro de estado: puede filtrar por estado de grupo
La función de búsqueda funciona en todos los nombres y descripciones de grupos.
Las opciones de clasificación ayudan a organizar los resultados según diferentes criterios.

Autorizaciones

Authorization

string

header

requerido

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

Parámetros de consulta

page

integer

predeterminado:1

Page number for pagination

Rango requerido: x >= 1

limit

integer

predeterminado:20

Number of groups per page

Rango requerido: 1 <= x <= 100

string

Search term for group name or description

status

enum<string>

Filter by group status

Opciones disponibles:

Active,

Inactive

sortBy

string

predeterminado:createdAt

Field to sort by

sortOrder

enum<string>

predeterminado:desc

Sort order

Opciones disponibles:

asc,

desc

Respuesta

List of groups

success

boolean

Ejemplo:

true

groups

object[]

Show child attributes

pagination

object

Show child attributes

Primeros Pasos y Configuración

Modelos y Generación AI

Knowledge Base y RAG

Seguridad, Guardrails y Auditoría

Usuarios y Acceso (IAM)

Facturación, Cuotas y Webhooks

Listar Grupos

Listar grupos

Endpoint

Descripción

Autenticación

Parámetros de consulta

Solicitud de ejemplo

Respuesta exitosa

Campos de respuesta

Ejemplo de uso

JavaScript

Pitón

rizo

Respuestas de error

401 No autorizado

403 Prohibido

429 Demasiadas solicitudes

Ejemplos de filtrado

Buscar grupos

Opciones de clasificación

Paginación

Casos de uso

Límites de tarifas

Notas

Autorizaciones

Parámetros de consulta

Respuesta

​Listar grupos

​Endpoint

​Descripción

​Autenticación

​Parámetros de consulta

​Solicitud de ejemplo

​Respuesta exitosa

​Campos de respuesta

​Ejemplo de uso

​JavaScript

​Pitón

​rizo

​Respuestas de error

​401 No autorizado

​403 Prohibido

​429 Demasiadas solicitudes

​Ejemplos de filtrado

​Buscar grupos

​Opciones de clasificación

​Paginación

​Casos de uso

​Límites de tarifas

​Notas

Autorizaciones

Parámetros de consulta

Respuesta

Listar grupos

Endpoint

Descripción

Autenticación

Parámetros de consulta

Solicitud de ejemplo

Respuesta exitosa

Campos de respuesta

Ejemplo de uso

JavaScript

Pitón

rizo

Respuestas de error

401 No autorizado

403 Prohibido

429 Demasiadas solicitudes

Ejemplos de filtrado

Buscar grupos

Opciones de clasificación

Paginación

Casos de uso

Límites de tarifas

Notas