> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hiperai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtenir tous les utilisateurs

> Retrieve all users with pagination and filtering. Only accessible by administrators.


# Obtenir tous les utilisateurs

Récupérez tous les utilisateurs avec la pagination et le filtrage. Accessible uniquement par les administrateurs.

## Point de terminaison

```
GET /users
```

## Description

Ce point de terminaison permet aux administrateurs de récupérer une liste paginée de tous les utilisateurs du système. Il prend en charge le filtrage selon divers critères, notamment le rôle, la licence, le statut et les termes de recherche. Il s'agit d'un point de terminaison administratif qui nécessite les autorisations appropriées.

## Authentification

Obligatoire. Incluez votre clé API dans l’en-tête Autorisation.

```bash theme={null}
Authorization: Bearer sk-your-api-key-here
```

## Demande

### Paramètres de requête

| Paramètre   | Tapez  | Obligatoire | Par défaut | Descriptif                                                               |
| ----------- | ------ | ----------- | ---------- | ------------------------------------------------------------------------ |
| `page`      | entier | Non         | 1          | Numéro de page pour la pagination                                        |
| `limit`     | entier | Non         | 20         | Nombre d'utilisateurs par page (1-100)                                   |
| `search`    | chaîne | Non         | -          | Terme de recherche pour le nom, l'adresse e-mail ou le nom d'utilisateur |
| `role`      | chaîne | Non         | -          | Filtrer par rôle utilisateur (admin, utilisateur, globalReader)          |
| `license`   | chaîne | Non         | -          | Filtrer par licence utilisateur (Essential, Growth, Ultra, Early Access) |
| `status`    | entier | Non         | -          | Filtrer par statut d'utilisateur (0=inactif, 1=actif)                    |
| `sortBy`    | chaîne | Non         | créé à     | Champ à trier par                                                        |
| `sortOrder` | chaîne | Non         | desc       | Ordre de tri (asc, desc)                                                 |

### Exemple de demande

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?page=1&limit=20&role=user&status=1" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

Avec recherche :

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?search=john&license=Growth" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

## Réponse

### Réponse réussie (200)

```json theme={null}
{
  "success": true,
  "users": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c23",
      "name": "John Doe",
      "username": "johndoe",
      "email": "john@example.com",
      "role": "user",
      "license": "Growth",
      "status": 1,
      "isVerified": true,
      "setupCompleted": true,
      "authType": "basic",
      "mfaEnabled": false,
      "customRole": {
        "id": "60a7c8f5e8b4f5001f7a8c24",
        "name": "custom_role",
        "displayName": "Custom Role"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "lastActive": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}
```

### Champs de réponse

| Champ                            | Tapez   | Descriptif                                                                  |
| -------------------------------- | ------- | --------------------------------------------------------------------------- |
| `success`                        | booléen | Toujours `true` pour les demandes réussies                                  |
| `users`                          | tableau | Tableau d'objets utilisateur                                                |
| `users[].id`                     | chaîne  | Identifiant unique de l'utilisateur                                         |
| `users[].name`                   | chaîne  | Nom complet de l'utilisateur                                                |
| `users[].username`               | chaîne  | Nom d'utilisateur de l'utilisateur                                          |
| `users[].email`                  | chaîne  | Adresse e-mail de l'utilisateur                                             |
| `users[].role`                   | chaîne  | Rôle de l'utilisateur (administrateur, utilisateur, globalReader)           |
| `users[].license`                | chaîne  | Niveau de licence de l'utilisateur (Essential, Growth, Ultra, Early Access) |
| `users[].status`                 | entier  | Statut de l'utilisateur (0=inactif, 1=actif)                                |
| `users[].isVerified`             | booléen | Si l'utilisateur est vérifié                                                |
| `users[].setupCompleted`         | booléen | Si la configuration utilisateur est terminée                                |
| `users[].authType`               | chaîne  | Type d'authentification (de base, auth0)                                    |
| `users[].mfaEnabled`             | booléen | Si MFA est activé                                                           |
| `users[].customRole`             | objet   | Informations sur le rôle personnalisé (si attribué)                         |
| `users[].customRole.id`          | chaîne  | ID de rôle personnalisé                                                     |
| `users[].customRole.name`        | chaîne  | Nom de rôle personnalisé                                                    |
| `users[].customRole.displayName` | chaîne  | Nom d'affichage du rôle personnalisé                                        |
| `users[].createdAt`              | chaîne  | Horodatage de création d'utilisateur                                        |
| `users[].updatedAt`              | chaîne  | Horodatage de la dernière mise à jour de l'utilisateur                      |
| `users[].lastActive`             | chaîne  | Horodatage de la dernière activité de l'utilisateur                         |
| `pagination`                     | objet   | Informations sur la pagination                                              |
| `pagination.page`                | entier  | Numéro de page actuel                                                       |
| `pagination.limit`               | entier  | Articles par page                                                           |
| `pagination.total`               | entier  | Nombre total d'utilisateurs                                                 |
| `pagination.pages`               | entier  | Nombre total de pages                                                       |

## Exemple d'utilisation

\###JavaScript

```javascript theme={null}
const response = await fetch('https://{customer.name}.hiperai.ai/api/external/users?page=1&limit=20', {
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here'
  }
});

const data = await response.json();

if (data.success) {
  console.log(`Showing ${data.users.length} of ${data.pagination.total} users`);
  data.users.forEach(user => {
    console.log(`${user.name} (${user.email}) - ${user.role}`);
  });
}
```

\###Python

```python theme={null}
import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here'
}

params = {
    'page': 1,
    'limit': 20,
    'role': 'user',
    'status': 1
}

response = requests.get('https://{customer.name}.hiperai.ai/api/external/users', 
                      headers=headers, params=params)
data = response.json()

if data['success']:
    print(f"Showing {len(data['users'])} of {data['pagination']['total']} users")
    for user in data['users']:
        print(f"{user['name']} ({user['email']}) - {user['role']}")
```

### boucle

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?page=1&limit=20" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

## Réponses d'erreur

### 401 Non autorisé

```json theme={null}
{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked"
}
```

### 403 Interdit

```json theme={null}
{
  "success": false,
  "error": "Access denied",
  "message": "Admin access required"
}
```

## Exemples de filtrage

### Recherche par nom ou par e-mail

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?search=john" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

### Filtrer par rôle

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?role=admin" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

### Filtrer par licence

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?license=Growth" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

### Filtrer par statut

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?status=1" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

### Trier par dernier actif

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?sortBy=lastActive&sortOrder=desc" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

## Cas d'utilisation

* **Gestion des utilisateurs** : affichez et gérez tous les utilisateurs du système
* **User Analytics** : analysez la répartition des utilisateurs par rôle, licence ou statut.
* **Recherche et filtre** : recherchez des utilisateurs spécifiques en fonction de divers critères
* **Tâches administratives** : Supporter les opérations administratives et les rapports

## Descriptions des rôles

* **admin** : accès complet au système avec contrôle administratif
* **utilisateur** : accès standard aux fonctionnalités de chat et aux bases de connaissances personnelles
* **globalReader** : accès en lecture seule au panneau d'administration avec autorisations d'affichage

## Descriptions des licences

* **Essential** : niveau de base avec 29 000 points/mois
* **Croissance** : niveau intermédiaire avec des fonctionnalités améliorées
* **Ultra** : niveau Premium avec un maximum de fonctionnalités
* **Accès anticipé** : niveau bêta avec capacités expérimentales

## Limites de taux

Ce point de terminaison suit les limites de débit standard :

* 60 requêtes par minute
* 1000 requêtes par heure


## OpenAPI

````yaml GET /users
openapi: 3.0.3
info:
  title: SecureAI External API
  description: >
    SecureAI External API provides AI chat completion and image generation
    capabilities with knowledge base retrieval, 

    security policies, and comprehensive usage tracking. This API is designed
    for external developers 

    and integrations using API key authentication.


    ## Key Features

    - **RAG (Retrieval-Augmented Generation)**: Automatically search knowledge
    bases for relevant context

    - **Multi-Model Support**: OpenAI, Anthropic, Google, Meta, and other AI
    models

    - **Model Redundancy & Failover**: Caller-defined failover chains (primary +
    fallbacks) with per-attempt timeouts

    - **OpenAI-Compatible Endpoint**: Point any OpenAI SDK at `/api/external/v1`
    — no code changes

    - **Image Generation**: Generate and edit images using Google Gemini 2.5
    Flash Image

    - **Speech-to-Speech (S2S)**: Real-time voice conversations using OpenAI
    Realtime API with WebRTC

    - **Security Policies**: SMLTP policy enforcement, per-call Prompt Shield,
    and signed compliance receipts

    - **Usage Tracking**: Comprehensive usage monitoring, self-service quota,
    and rate limiting

    - **Knowledge Base Integration**: Access to personal and shared knowledge
    bases

    - **User Management**: Complete user, group, and role management
    capabilities

    - **Audit Logging**: Comprehensive activity and security audit logs


    ## Authentication

    All endpoints (except health check) require API key authentication using
    Bearer token:

    ```

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

    ```


    ## Billing and Usage

    By default, API requests are billed to the user account that owns the API
    key. You can specify 

    a different user to bill by including the `user_id` parameter in your
    request. This allows for:

    - Multi-tenant applications with per-user billing

    - Flexible completion limit management

    - Per-user "Usage by Model" settings


    ## Rate Limits

    - Default: 60 requests per minute, 1000 requests per hour

    - Daily limits: 100 requests (configurable)

    - Monthly limits: 10,000 requests (configurable)


    ## Base URL

    ```

    https://secureai.hiperai.ai/api/external

    ```
  version: 1.1.0
  contact:
    name: SecureAI Support
    email: support@secureai.hiperai.ai
  license:
    name: Proprietary
    url: https://secureai.hiperai.ai/terms
servers:
  - url: https://secureai.hiperai.ai/api/external
    description: Production server
  - url: http://localhost:3010/api/external
    description: Development server
security:
  - ApiKeyAuth: []
tags:
  - name: System
    description: System health and status endpoints
  - name: Discovery
    description: Endpoints to discover available models, indexes, and policies
  - name: Chat
    description: AI chat completion endpoints
  - name: User Management
    description: Endpoints for managing user accounts and roles
  - name: Index Management
    description: Endpoints for managing knowledge base indexes
  - name: Group Management
    description: Endpoints for managing user groups
  - name: SMLTP Security
    description: Endpoints for managing SMLTP security policies and audit logs
  - name: Role Management
    description: Endpoints for managing user roles
  - name: Activity Logs
    description: Endpoints for retrieving activity logs
externalDocs:
  description: SecureAI Documentation
  url: https://secureai.hiperai.ai/docs
paths:
  /users:
    get:
      tags:
        - User Management
      summary: Get All Users
      description: >
        Retrieve all users with pagination and filtering. Only accessible by
        administrators.
      parameters:
        - name: page
          in: query
          description: Page number for pagination
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: limit
          in: query
          description: Number of users per page
          required: false
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 100
        - name: search
          in: query
          description: Search term for name, email, or username
          required: false
          schema:
            type: string
        - name: role
          in: query
          description: Filter by user role
          required: false
          schema:
            type: string
            enum:
              - admin
              - user
              - globalReader
        - name: license
          in: query
          description: Filter by user license
          required: false
          schema:
            type: string
            enum:
              - Essential
              - Growth
              - Ultra
              - Early Access
        - name: status
          in: query
          description: Filter by user status (0=inactive, 1=active)
          required: false
          schema:
            type: integer
            enum:
              - 0
              - 1
        - name: sortBy
          in: query
          description: Field to sort by
          required: false
          schema:
            type: string
            default: createdAt
        - name: sortOrder
          in: query
          description: Sort order
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 60a7c8f5e8b4f5001f7a8c23
                        name:
                          type: string
                          example: John Doe
                        username:
                          type: string
                          example: johndoe
                        email:
                          type: string
                          example: john@example.com
                        role:
                          type: string
                          example: user
                        license:
                          type: string
                          example: Growth
                        status:
                          type: integer
                          example: 1
                        isVerified:
                          type: boolean
                          example: true
                        setupCompleted:
                          type: boolean
                          example: true
                        authType:
                          type: string
                          example: basic
                        mfaEnabled:
                          type: boolean
                          example: false
                        customRole:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              example: 60a7c8f5e8b4f5001f7a8c24
                            name:
                              type: string
                              example: custom_role
                            displayName:
                              type: string
                              example: Custom Role
                        createdAt:
                          type: string
                          format: date-time
                          example: '2024-01-01T00:00:00.000Z'
                        updatedAt:
                          type: string
                          format: date-time
                          example: '2024-01-15T10:30:00.000Z'
                        lastActive:
                          type: string
                          format: date-time
                          example: '2024-01-15T10:30:00.000Z'
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        example: 1
                      limit:
                        type: integer
                        example: 20
                      total:
                        type: integer
                        example: 150
                      pages:
                        type: integer
                        example: 8
        '401':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied - admin only
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Invalid API key
        message:
          type: string
          example: The provided API key is invalid or has been revoked
        request_id:
          type: string
          example: req-abc123
          description: Request ID for tracking (if available)
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key authentication using Bearer token format.
        Example: `Authorization: Bearer sk-your-api-key-here`

````