> ## 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.

# Répertorier les rôles

> Récupérer tous les rôles d'utilisateur disponibles

# Liste des rôles

Récupérez tous les rôles d'utilisateur disponibles dans le système SecureAI.

## Point de terminaison

```
GET /roles
```

## Description

Ce point de terminaison renvoie tous les rôles d'utilisateur disponibles dans le système SecureAI. Il fournit des informations détaillées sur chaque rôle, notamment les autorisations, les descriptions et les métadonnées. Ceci est utile pour comprendre les rôles disponibles et leurs capacités.

## 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 (par défaut : 1)                   |
| `limit`     | entier | Non         | 20         | Nombre de rôles par page (par défaut : 20)                           |
| `search`    | chaîne | Non         | -          | Terme de recherche pour le nom, le nom d'affichage ou la description |
| `isSystem`  | chaîne | Non         | -          | Filtrer par rôles système (vrai/faux)                                |
| `sortBy`    | chaîne | Non         | créé à     | Champ de tri (par défaut : "createdAt")                              |
| `sortOrder` | chaîne | Non         | desc       | Ordre de tri (asc/desc, par défaut : "desc")                         |

## Exemple de demande

```bash theme={null}
GET /roles?page=1&limit=10&search=admin
```

## Réponse réussie

**Code d'état** : `200 OK`

```json theme={null}
{
  "success": true,
  "roles": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c26",
      "name": "custom_role",
      "displayName": "Custom Role",
      "description": "Custom role with specific permissions",
      "isSystem": false,
      "hasAdminPanelAccess": true,
      "permissions": [
        {
          "section": "user-management",
          "level": "admin"
        },
        {
          "section": "index-management",
          "level": "reader"
        }
      ],
      "canInteractWithAI": true,
      "canUseChat": true,
      "userCount": 5,
      "createdBy": {
        "id": "60a7c8f5e8b4f5001f7a8c24",
        "name": "John Doe",
        "email": "john@example.com"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "pages": 3
  }
}
```

### Champs de réponse

| Champ                           | Tapez   | Descriptif                                             |
| ------------------------------- | ------- | ------------------------------------------------------ |
| `success`                       | booléen | Indique si l'opération a réussi                        |
| `roles`                         | tableau | Tableau d'objets de rôle                               |
| `roles[].id`                    | chaîne  | Identificateur de rôle unique                          |
| `roles[].name`                  | chaîne  | Nom du rôle                                            |
| `roles[].displayName`           | chaîne  | Nom d'affichage du rôle                                |
| `roles[].description`           | chaîne  | Description du rôle                                    |
| `roles[].isSystem`              | booléen | S'il s'agit d'un rôle système                          |
| `roles[].hasAdminPanelAccess`   | booléen | Indique si le rôle a accès au panneau d'administration |
| `roles[].permissions`           | tableau | Tableau d'objets d'autorisation                        |
| `roles[].permissions[].section` | chaîne  | Section autorisations                                  |
| `roles[].permissions[].level`   | chaîne  | Niveau d'autorisation                                  |
| `roles[].canInteractWithAI`     | booléen | Si le rôle peut interagir avec l'IA                    |
| `roles[].canUseChat`            | booléen | Indique si le rôle peut utiliser le chat               |
| `roles[].userCount`             | entier  | Nombre d'utilisateurs avec ce rôle                     |
| `roles[].createdBy`             | objet   | Utilisateur qui a créé le rôle                         |
| `roles[].createdBy.id`          | chaîne  | ID utilisateur du créateur                             |
| `roles[].createdBy.name`        | chaîne  | Nom du créateur                                        |
| `roles[].createdBy.email`       | chaîne  | E-mail du créateur                                     |
| `roles[].createdAt`             | chaîne  | Horodatage de création                                 |
| `roles[].updatedAt`             | chaîne  | Horodatage de la dernière mise à jour                  |
| `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 de rôles                                  |
| `pagination.pages`              | entier  | Nombre total de pages                                  |

## Exemple d'utilisation

\###JavaScript

```javascript theme={null}
const listRoles = async (params = {}) => {
  const queryString = new URLSearchParams(params).toString();
  const url = `https://{customer.name}.hiperai.ai/api/external/roles${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 listRoles({
  page: 1,
  limit: 10,
  search: 'admin'
});
console.log(result.roles);
```

\###Python

```python theme={null}
import requests

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

# Example usage
params = {
    "page": 1,
    "limit": 10,
    "search": "admin"
}

result = list_roles(params)
print(result["roles"])
```

### boucle

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

## Réponses d'erreur

### 401 Non autorisé

```json theme={null}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
```

### 403 Interdit

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Admin privileges required"
  }
}
```

### 429 Trop de demandes

```json theme={null}
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "retryAfter": 60
  }
}
```

## Cas d'utilisation

* **Gestion des rôles** : répertoriez tous les rôles disponibles pour l'attribution des utilisateurs
* **Révision des autorisations** : comprenez les autorisations dont dispose chaque rôle
* **Contrôle d'accès** : planifiez l'accès des utilisateurs en fonction des rôles disponibles
* **Affectation des utilisateurs** : attribuez des rôles aux utilisateurs en fonction de leurs besoins
* **Analyse des rôles** : analysez l'utilisation des rôles et la répartition des utilisateurs

## 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écessite des privilèges d'administrateur
* Pagination basée sur la page : utilise le paramètre de page, pas le décalage
* Rechercher : recherche dans les champs de nom, displayName et de description
* Rôles système : peut filtrer par rôles système ou personnalisés
* Tri : peut trier selon n'importe quel champ par ordre croissant ou décroissant
* Réponse plate : la réponse n'est pas imbriquée sous l'objet de données
* Nombre d'utilisateurs : indique combien d'utilisateurs ont chaque rôle
* Informations sur le créateur : indique qui a créé chaque rôle


## OpenAPI

````yaml GET /roles
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:
  /roles:
    get:
      tags:
        - Role Management
      summary: Get All Roles
      description: >
        Retrieve all roles with their permissions. 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 roles per page
          required: false
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 100
        - name: search
          in: query
          description: Search term for role name, display name, or description
          required: false
          schema:
            type: string
        - name: isSystem
          in: query
          description: Filter by system roles
          required: false
          schema:
            type: string
            enum:
              - true
              - false
        - 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 roles
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 60a7c8f5e8b4f5001f7a8c26
                        name:
                          type: string
                          example: custom_role
                        displayName:
                          type: string
                          example: Custom Role
                        description:
                          type: string
                          example: Custom role with specific permissions
                        isSystem:
                          type: boolean
                          example: false
                        hasAdminPanelAccess:
                          type: boolean
                          example: true
                        permissions:
                          type: array
                          items:
                            type: object
                            properties:
                              section:
                                type: string
                                example: user-management
                              level:
                                type: string
                                enum:
                                  - none
                                  - reader
                                  - admin
                                example: admin
                        canInteractWithAI:
                          type: boolean
                          example: true
                        canUseChat:
                          type: boolean
                          example: true
                        userCount:
                          type: integer
                          example: 5
                        createdBy:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              example: 60a7c8f5e8b4f5001f7a8c24
                            name:
                              type: string
                              example: John Doe
                            email:
                              type: string
                              example: john@example.com
                        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'
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        example: 1
                      limit:
                        type: integer
                        example: 20
                      total:
                        type: integer
                        example: 50
                      pages:
                        type: integer
                        example: 3
        '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`

````