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

Gruppen auflisten

Rufen Sie eine Liste aller Benutzergruppen im System mit Paginierungs- und Filteroptionen ab.

Endpunkt

GET /groups

Beschreibung

Dieser Endpunkt gibt alle im SecureAI-System verfügbaren Benutzergruppen zurück. Es bietet detaillierte Informationen zu jeder Gruppe, einschließlich Mitgliedern, Berechtigungen und Metadaten. Dies ist nützlich für die Verwaltung des Benutzerzugriffs und der Organisationsstruktur.

Authentifizierung

Erforderlich: API-Schlüssel mit Administratorrechten

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

Abfrageparameter

Parameter	Geben Sie	ein Erforderlich	Beschreibung
`page`	Ganzzahl	Nein	1	Seitenzahl für Paginierung
`limit`	Ganzzahl	Nein	20	Anzahl der Gruppen pro Seite (1-100)
`search`	Zeichenfolge	Nein	-	Suchbegriff für Gruppennamen oder Beschreibung
`status`	Zeichenfolge	Nein	-	Nach Gruppenstatus filtern
`sortBy`	Zeichenfolge	Nein	erstellt am	Feld zum Sortieren nach
`sortOrder`	Zeichenfolge	Nein	absteigend	Sortierreihenfolge (aufsteigend, absteigend)

Beispielanfrage

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

Erfolgsantwort

Statuscode: 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
  }
}

Antwortfelder

Feld	Geben Sie	ein Beschreibung
`success`	boolescher Wert	Zeigt an, ob der Vorgang erfolgreich war
`groups[]`	Array	Array von Gruppenobjekten
`groups[].id`	Zeichenfolge	Eindeutiger Gruppenbezeichner
`groups[].name`	Zeichenfolge	Gruppenname
`groups[].description`	Zeichenfolge	Gruppenbeschreibung
`groups[].status`	Zeichenfolge	Gruppenstatus
`groups[].userCount`	Ganzzahl	Anzahl der Benutzer in der Gruppe
`groups[].users`	Array	Array von Benutzerobjekten in der Gruppe
`groups[].users[].id`	Zeichenfolge	Benutzer-ID
`groups[].users[].name`	Zeichenfolge	Benutzername
`groups[].users[].email`	Zeichenfolge	Benutzer-E-Mail
`groups[].createdAt`	Zeichenfolge	Erstellungszeitstempel
`pagination`	Objekt	Informationen zur Paginierung

Beispielverwendung

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

cURL

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"

Fehlerantworten

401 Nicht autorisiert

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

403 Verboten

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

429 Zu viele Anfragen

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

Filterbeispiele

Suchgruppen

# Search by name
GET /groups?search=engineering

# Search by description
GET /groups?search=development

Sortieroptionen

# 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

Paginierung

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

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

Anwendungsfälle

Gruppenverwaltung: Alle Gruppen zu Verwaltungszwecken auflisten
Benutzerorganisation: Entdecken Sie verfügbare Gruppen für die Benutzerzuweisung
Zugriffskontrolle: Überprüfen Sie Gruppenberechtigungen und Mitgliederzahlen
Berichterstellung: Erstellen Sie Berichte über Gruppenstruktur und Mitgliedschaft
Integration: Entdecken Sie Gruppen für die Anwendungsintegration

Tarifbegrenzungen

Standard: 100 Anfragen pro Minute
Täglich: 10.000 Anfragen pro Tag
Monatlich: 300.000 Anfragen pro Monat

Notizen

– Auf diesen Endpunkt können nur Administratoren zugreifen

Paginierung: Verwendet Seitenparameter, keinen Offset
Flache Antwort: Die Antwort ist nicht unter dem Datenobjekt verschachtelt
Benutzerdetails: Enthält vollständige Benutzerinformationen für jedes Gruppenmitglied
Statusfilter: Kann nach Gruppenstatus filtern
Die Suchfunktion funktioniert über Gruppennamen und Beschreibungen hinweg
Sortieroptionen helfen dabei, Ergebnisse nach verschiedenen Kriterien zu organisieren

Autorisierungen

Authorization

string

header

erforderlich

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

Abfrageparameter

page

integer

Standard:1

Page number for pagination

Erforderlicher Bereich: x >= 1

limit

integer

Standard:20

Number of groups per page

Erforderlicher Bereich: 1 <= x <= 100

string

Search term for group name or description

status

enum<string>

Filter by group status

Verfügbare Optionen:

Active,

Inactive

sortBy

string

Standard:createdAt

Field to sort by

sortOrder

enum<string>

Standard:desc

Sort order

Verfügbare Optionen:

asc,

desc

Antwort

List of groups

success

boolean

Beispiel:

true

groups

object[]

Show child attributes

pagination

object

Show child attributes

Erste Schritte & Setup

Modelle & KI-Generierung

Knowledge Base & RAG

Sicherheit, Guardrails & Auditierung

Benutzer & Zugriff (IAM)

Abrechnung, Kontingente & Webhooks

Gruppen auflisten

Gruppen auflisten

Endpunkt

Beschreibung

Authentifizierung

Abfrageparameter

Beispielanfrage

Erfolgsantwort

Antwortfelder

Beispielverwendung

JavaScript

Python

cURL

Fehlerantworten

401 Nicht autorisiert

403 Verboten

429 Zu viele Anfragen

Filterbeispiele

Suchgruppen

Sortieroptionen

Paginierung

Anwendungsfälle

Tarifbegrenzungen

Notizen

Autorisierungen

Abfrageparameter

Antwort

​Gruppen auflisten

​Endpunkt

​Beschreibung

​Authentifizierung

​Abfrageparameter

​Beispielanfrage

​Erfolgsantwort

​Antwortfelder

​Beispielverwendung

​JavaScript

​Python

​cURL

​Fehlerantworten

​401 Nicht autorisiert

​403 Verboten

​429 Zu viele Anfragen

​Filterbeispiele

​Suchgruppen

​Sortieroptionen

​Paginierung

​Anwendungsfälle

​Tarifbegrenzungen

​Notizen

Autorisierungen

Abfrageparameter

Antwort

Gruppen auflisten

Endpunkt

Beschreibung

Authentifizierung

Abfrageparameter

Beispielanfrage

Erfolgsantwort

Antwortfelder

Beispielverwendung

JavaScript

Python

cURL

Fehlerantworten

401 Nicht autorisiert

403 Verboten

429 Zu viele Anfragen

Filterbeispiele

Suchgruppen

Sortieroptionen

Paginierung

Anwendungsfälle

Tarifbegrenzungen

Notizen