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

# Créer un rôle

> Créer un nouveau rôle d'utilisateur

# Créer un rôle

Créez un nouveau rôle d'utilisateur personnalisé avec des autorisations spécifiques.

## Point de terminaison

```
POST /roles
```

## Description

Ce point de terminaison permet aux administrateurs de créer de nouveaux rôles d'utilisateur personnalisés. Les rôles personnalisés peuvent disposer d'autorisations spécifiques adaptées aux besoins de votre organisation. Vous pouvez spécifier le nom du rôle, la description et les autorisations lors de la création.

## Authentification

**Obligatoire** : clé API avec privilèges d'administrateur

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

## Corps de la demande

| Paramètre             | Tapez   | Obligatoire | Descriptif                                                                  |
| --------------------- | ------- | ----------- | --------------------------------------------------------------------------- |
| `name`                | chaîne  | Oui         | Nom du rôle (identifiant du système)                                        |
| `displayName`         | chaîne  | Oui         | Nom de rôle lisible par l'homme                                             |
| `description`         | chaîne  | Oui         | Description du rôle objectif                                                |
| `hasAdminPanelAccess` | booléen | Non         | Indique si le rôle a accès au panneau d'administration (par défaut : false) |
| `permissions`         | tableau | Non         | Tableau d'objets d'autorisation                                             |
| `canInteractWithAI`   | booléen | Non         | Indique si le rôle peut interagir avec l'IA (par défaut : vrai)             |
| `canUseChat`          | booléen | Non         | Indique si le rôle peut utiliser le chat (par défaut : vrai)                |

## Exemple de demande

```json theme={null}
{
  "name": "content_editor",
  "displayName": "Content Editor",
  "description": "Role for editing and managing content",
  "hasAdminPanelAccess": false,
  "permissions": [
    {
      "section": "user-management",
      "level": "reader"
    },
    {
      "section": "index-management",
      "level": "admin"
    }
  ],
  "canInteractWithAI": true,
  "canUseChat": true
}
```

## Réponse réussie

**Code d'état** : `201 Created`

```json theme={null}
{
  "success": true,
  "message": "Role created successfully",
  "role": {
    "id": "60a7c8f5e8b4f5001f7a8c26",
    "name": "content_editor",
    "displayName": "Content Editor",
    "description": "Role for editing and managing content",
    "isSystem": false,
    "hasAdminPanelAccess": false,
    "permissions": [
      {
        "section": "user-management",
        "level": "reader"
      },
      {
        "section": "index-management",
        "level": "admin"
      }
    ],
    "canInteractWithAI": true,
    "canUseChat": true,
    "userCount": 0,
    "createdBy": {
      "id": "60a7c8f5e8b4f5001f7a8c24",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "createdAt": "2024-01-20T15:30:00.000Z"
  }
}
```

### Champs de réponse

| Champ                        | Tapez   | Descriptif                                             |
| ---------------------------- | ------- | ------------------------------------------------------ |
| `success`                    | booléen | Indique si l'opération a réussi                        |
| `message`                    | chaîne  | Message de réussite                                    |
| `role`                       | objet   | Objet de rôle créé                                     |
| `role.id`                    | chaîne  | Identificateur de rôle unique                          |
| `role.name`                  | chaîne  | Nom du rôle                                            |
| `role.displayName`           | chaîne  | Nom d'affichage du rôle                                |
| `role.description`           | chaîne  | Description du rôle                                    |
| `role.isSystem`              | booléen | S'il s'agit d'un rôle système                          |
| `role.hasAdminPanelAccess`   | booléen | Indique si le rôle a accès au panneau d'administration |
| `role.permissions`           | tableau | Tableau d'objets d'autorisation                        |
| `role.permissions[].section` | chaîne  | Section autorisations                                  |
| `role.permissions[].level`   | chaîne  | Niveau d'autorisation                                  |
| `role.canInteractWithAI`     | booléen | Si le rôle peut interagir avec l'IA                    |
| `role.canUseChat`            | booléen | Indique si le rôle peut utiliser le chat               |
| `role.userCount`             | entier  | Nombre d'utilisateurs avec ce rôle                     |
| `role.createdBy`             | objet   | Utilisateur qui a créé le rôle                         |
| `role.createdBy.id`          | chaîne  | ID utilisateur du créateur                             |
| `role.createdBy.name`        | chaîne  | Nom du créateur                                        |
| `role.createdBy.email`       | chaîne  | E-mail du créateur                                     |
| `role.createdAt`             | chaîne  | Horodatage de création                                 |

## Exemple d'utilisation

\###JavaScript

```javascript theme={null}
const createRole = async (roleData) => {
  const response = await fetch('https://{customer.name}.hiperai.ai/api/external/roles', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer sk-your-api-key-here',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(roleData)
  });
  
  return await response.json();
};

// Example usage
const roleData = {
  name: "content_editor",
  displayName: "Content Editor",
  description: "Role for editing and managing content",
  hasAdminPanelAccess: false,
  permissions: [
    {
      section: "user-management",
      level: "reader"
    },
    {
      section: "index-management",
      level: "admin"
    }
  ],
  canInteractWithAI: true,
  canUseChat: true
};

const result = await createRole(roleData);
console.log('Created role:', result.role.id);
```

\###Python

```python theme={null}
import requests

def create_role(role_data):
    url = "https://{customer.name}.hiperai.ai/api/external/roles"
    headers = {
        "Authorization": "Bearer sk-your-api-key-here",
        "Content-Type": "application/json"
    }
    
    response = requests.post(url, headers=headers, json=role_data)
    return response.json()

# Example usage
role_data = {
    "name": "content_editor",
    "displayName": "Content Editor",
    "description": "Role for editing and managing content",
    "hasAdminPanelAccess": False,
    "permissions": [
        {
            "section": "user-management",
            "level": "reader"
        },
        {
            "section": "index-management",
            "level": "admin"
        }
    ],
    "canInteractWithAI": True,
    "canUseChat": True
}

result = create_role(role_data)
print("Created role:", result["role"]["id"])
```

### boucle

```bash theme={null}
curl -X POST "https://{customer.name}.hiperai.ai/api/external/roles" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "content_editor",
    "displayName": "Content Editor",
    "description": "Role for editing and managing content",
    "hasAdminPanelAccess": false,
    "permissions": [
      {
        "section": "user-management",
        "level": "reader"
      },
      {
        "section": "index-management",
        "level": "admin"
      }
    ],
    "canInteractWithAI": true,
    "canUseChat": true
  }'
```

## Réponses d'erreur

### 400 Requête incorrecte

```json theme={null}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Role name is required",
    "details": {
      "field": "name",
      "value": null
    }
  }
}
```

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

### 409 Conflit

```json theme={null}
{
  "success": false,
  "error": {
    "code": "ROLE_NAME_EXISTS",
    "message": "Role name already exists"
  }
}
```

### 429 Trop de demandes

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

## Sections d'autorisation disponibles

| Rubrique           | Descriptif                             |
| ------------------ | -------------------------------------- |
| `home`             | Accès au tableau de bord d'accueil     |
| `user-management`  | Opérations de gestion des utilisateurs |
| `index-management` | Opérations de gestion d'indices        |
| `analytics`        | Analyses et rapports                   |
| `group-management` | Opérations de gestion du groupe        |
| `integrations`     | Gestion de l'intégration               |
| `services-status`  | Surveillance de l'état des services    |
| `settings`         | Paramètres système                     |
| `announcements`    | Gestion des annonces                   |
| `smltp-security`   | Fonctionnalités de sécurité SMLTP      |

## Niveaux d'autorisation disponibles

| Niveau   | Descriptif                               |
| -------- | ---------------------------------------- |
| `none`   | Pas d'accès à la section                 |
| `reader` | Accès en lecture seule à la section      |
| `admin`  | Accès administratif complet à la section |

## Cas d'utilisation

* **Rôles personnalisés** : créez des rôles adaptés aux besoins de votre organisation
* **Contrôle d'accès** : définissez des autorisations spécifiques pour différents types d'utilisateurs
* **Sécurité** : mettre en œuvre les principes d'accès du moindre privilège
* **Conformité** : créez des rôles qui répondent aux exigences réglementaires
* **Intégration** : définir des rôles pour l'intégration de systèmes tiers

## Limites de taux

* **Par défaut** : 50 requêtes par minute
* **Quotidien** : 5 000 requêtes par jour
* **Mensuel** : 150 000 demandes par mois

## Remarques

* **Administrateur uniquement** : ce point de terminaison nécessite des privilèges d'administrateur
* **Champs obligatoires** : le nom, le displayName et la description sont obligatoires
* **Structure des autorisations** : les autorisations sont des objets avec des propriétés de section et de niveau.
* **Rôles système** : les rôles personnalisés ne sont jamais des rôles système
* **Réponse plate** : la réponse n'est pas imbriquée sous l'objet de données
* **Informations sur le créateur** : indique qui a créé le rôle
* **Nombre d'utilisateurs** : commence à 0 pour les nouveaux rôles
* Les noms de rôle doivent être uniques dans le système
* Le rôle est immédiatement disponible pour l'affectation des utilisateurs


## OpenAPI

````yaml POST /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:
    post:
      tags:
        - Role Management
      summary: Create New Role
      description: |
        Create a new custom role. Only accessible by administrators.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - displayName
                - description
              properties:
                name:
                  type: string
                  description: Role name (lowercase, no spaces)
                  example: custom_role
                displayName:
                  type: string
                  description: Display name for the role
                  example: Custom Role
                description:
                  type: string
                  description: Role description
                  example: Custom role with specific permissions
                hasAdminPanelAccess:
                  type: boolean
                  default: false
                  description: Whether role has admin panel access
                  example: true
                permissions:
                  type: array
                  items:
                    type: object
                    properties:
                      section:
                        type: string
                        enum:
                          - home
                          - user-management
                          - index-management
                          - analytics
                          - group-management
                          - integrations
                          - services-status
                          - settings
                          - announcements
                          - smltp-security
                        example: user-management
                      level:
                        type: string
                        enum:
                          - none
                          - reader
                          - admin
                        example: admin
                  description: Array of permission objects
                  example:
                    - section: user-management
                      level: admin
                    - section: index-management
                      level: reader
                canInteractWithAI:
                  type: boolean
                  default: true
                  description: Whether role can interact with AI
                  example: true
                canUseChat:
                  type: boolean
                  default: true
                  description: Whether role can use chat
                  example: true
            example:
              name: custom_role
              displayName: Custom Role
              description: Custom role with specific permissions
              hasAdminPanelAccess: true
              permissions:
                - section: user-management
                  level: admin
                - section: index-management
                  level: reader
              canInteractWithAI: true
              canUseChat: true
      responses:
        '201':
          description: Role created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Role created successfully
                  role:
                    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
                              example: admin
                      canInteractWithAI:
                        type: boolean
                        example: true
                      canUseChat:
                        type: boolean
                        example: true
                      userCount:
                        type: integer
                        example: 0
                      createdBy:
                        type: object
                        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-15T10:30:00.000Z'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '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'
        '409':
          description: Role name already exists
          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`

````