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"
}

Liste des groupes

Récupérez une liste de tous les groupes d’utilisateurs du système avec des options de pagination et de filtrage.

Point de terminaison

GET /groups

Description

Ce point de terminaison renvoie tous les groupes d’utilisateurs disponibles dans le système SecureAI. Il fournit des informations détaillées sur chaque groupe, notamment les membres, les autorisations et les métadonnées. Ceci est utile pour gérer l’accès des utilisateurs et la structure organisationnelle.

Authentification

Obligatoire : clé API avec privilèges d’administrateur

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

Paramètres de requête

Paramètre	Tapez	Obligatoire	Descriptif
`page`	entier	Non	1	Numéro de page pour la pagination
`limit`	entier	Non	20	Nombre de groupes par page (1-100)
`search`	chaîne	Non	-	Terme de recherche pour le nom ou la description du groupe
`status`	chaîne	Non	-	Filtrer par statut de groupe
`sortBy`	chaîne	Non	créé à	Champ à trier par
`sortOrder`	chaîne	Non	desc	Ordre de tri (asc, desc)

Exemple de demande

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

Réponse réussie

Code d’état : 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
  }
}

Champs de réponse

Champ	Tapez	Descriptif
`success`	booléen	Indique si l’opération a réussi
`groups[]`	tableau	Tableau d’objets de groupe
`groups[].id`	chaîne	Identifiant unique du groupe
`groups[].name`	chaîne	Nom du groupe
`groups[].description`	chaîne	Description du groupe
`groups[].status`	chaîne	Statut du groupe
`groups[].userCount`	entier	Nombre d’utilisateurs dans le groupe
`groups[].users`	tableau	Tableau d’objets utilisateur dans le groupe
`groups[].users[].id`	chaîne	Identifiant utilisateur
`groups[].users[].name`	chaîne	Nom d’utilisateur
`groups[].users[].email`	chaîne	E-mail de l’utilisateur
`groups[].createdAt`	chaîne	Horodatage de création
`pagination`	objet	Informations sur la pagination

Exemple d’utilisation

###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);

###Python

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"])

boucle

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"

Réponses d’erreur

401 Non autorisé

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

403 Interdit

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

429 Trop de demandes

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

Exemples de filtrage

Groupes de recherche

# Search by name
GET /groups?search=engineering

# Search by description
GET /groups?search=development

Options de tri

# 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

Pagination

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

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

Cas d’utilisation

Gestion des groupes : répertoriez tous les groupes à des fins administratives
Organisation des utilisateurs : découvrez les groupes disponibles pour l’affectation des utilisateurs
Contrôle d’accès : vérifiez les autorisations du groupe et le nombre de membres
Reporting : Générez des rapports sur la structure et l’adhésion du groupe
Intégration : découvrez des groupes pour l’intégration d’applications

Limites de taux

Par défaut : 100 requêtes par minute
Quotidien : 10 000 requêtes par jour
Mensuel : 300 000 demandes par mois

Remarques

Ce point de terminaison n’est accessible que par les administrateurs
Pagination : utilise le paramètre de page, pas le décalage
Réponse plate : la réponse n’est pas imbriquée sous l’objet de données
Détails de l’utilisateur : comprend des informations utilisateur complètes pour chaque membre du groupe
Filtre de statut : peut filtrer par statut de groupe
La fonctionnalité de recherche fonctionne sur les noms et descriptions de groupes
Les options de tri aident à organiser les résultats selon différents critères

Autorisations

Authorization

string

header

requis

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

Paramètres de requête

page

integer

défaut:1

Page number for pagination

Plage requise: x >= 1

limit

integer

défaut:20

Number of groups per page

Plage requise: 1 <= x <= 100

string

Search term for group name or description

status

enum<string>

Filter by group status

Options disponibles:

Active,

Inactive

sortBy

string

défaut:createdAt

Field to sort by

sortOrder

enum<string>

défaut:desc

Sort order

Options disponibles:

asc,

desc

Réponse

List of groups

success

boolean

Exemple:

true

groups

object[]

Show child attributes

pagination

object

Show child attributes

Premiers Pas & Configuration

Modèles & Génération IA

Base de Connaissances & RAG

Sécurité, Guardrails & Audit

Utilisateurs & Accès (IAM)

Facturation, Quotas & Webhooks

Liste des groupes

Liste des groupes

Point de terminaison

Description

Authentification

Paramètres de requête

Exemple de demande

Réponse réussie

Champs de réponse

Exemple d’utilisation

boucle

Réponses d’erreur

401 Non autorisé

403 Interdit

429 Trop de demandes

Exemples de filtrage

Groupes de recherche

Options de tri

Cas d’utilisation

Limites de taux

Remarques

Autorisations

Paramètres de requête

Réponse

​Liste des groupes

​Point de terminaison

​Description

​Authentification

​Paramètres de requête

​Exemple de demande

​Réponse réussie

​Champs de réponse

​Exemple d’utilisation

​boucle

​Réponses d’erreur

​401 Non autorisé

​403 Interdit

​429 Trop de demandes

​Exemples de filtrage

​Groupes de recherche

​Options de tri

​Pagination

​Cas d’utilisation

​Limites de taux

​Remarques

Autorisations

Paramètres de requête

Réponse

Liste des groupes

Point de terminaison

Description

Authentification

Paramètres de requête

Exemple de demande

Réponse réussie

Champs de réponse

Exemple d’utilisation

boucle

Réponses d’erreur

401 Non autorisé

403 Interdit

429 Trop de demandes

Exemples de filtrage

Groupes de recherche

Options de tri

Pagination

Cas d’utilisation

Limites de taux

Remarques