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

# Mettre à jour l'utilisateur

> Mettre à jour un compte utilisateur existant

# Mettre à jour l'utilisateur

Mettez à jour un compte utilisateur existant avec de nouvelles informations.

## Point de terminaison

```
PUT /users/{userId}
```

## Description

Ce point de terminaison permet aux administrateurs de mettre à jour un compte utilisateur existant. Vous pouvez modifier les détails de l'utilisateur tels que le nom, l'adresse e-mail, le rôle, le niveau de licence et d'autres paramètres de compte.

## Authentification

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

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

## Paramètres du chemin

| Paramètre | Tapez  | Obligatoire | Descriptif                                            |
| --------- | ------ | ----------- | ----------------------------------------------------- |
| `userId`  | chaîne | Oui         | L'identifiant unique de l'utilisateur à mettre à jour |

## Corps de la demande

| Paramètre        | Tapez   | Obligatoire | Descriptif                                                   |
| ---------------- | ------- | ----------- | ------------------------------------------------------------ |
| `name`           | chaîne  | Non         | Nom complet de l'utilisateur                                 |
| `username`       | chaîne  | Non         | Nom d'utilisateur unique pour l'utilisateur                  |
| `email`          | chaîne  | Non         | Adresse email de l'utilisateur                               |
| `password`       | chaîne  | Non         | Nouveau mot de passe pour le compte utilisateur              |
| `role`           | chaîne  | Non         | Rôle utilisateur (administrateur, utilisateur, globalReader) |
| `license`        | chaîne  | Non         | Niveau de licence (Essential, Growth, Ultra, Early Access)   |
| `status`         | entier  | Non         | Statut du compte (0=inactif, 1=actif)                        |
| `roleId`         | chaîne  | Non         | ID de rôle personnalisé (MongoDB ObjectId)                   |
| `setupCompleted` | booléen | Non         | Si la configuration utilisateur est terminée                 |
| `isVerified`     | booléen | Non         | Si l'utilisateur est vérifié                                 |

## Exemple de demande

```json theme={null}
{
  "name": "John Doe Updated",
  "email": "john.updated@example.com",
  "role": "user",
  "license": "Growth",
  "status": 1,
  "setupCompleted": true,
  "isVerified": true
}
```

## Réponse réussie

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

```json theme={null}
{
  "success": true,
  "message": "User updated successfully",
  "user": {
    "id": "60a7c8f5e8b4f5001f7a8c23",
    "name": "John Doe Updated",
    "username": "johndoe",
    "email": "john.updated@example.com",
    "role": "user",
    "license": "Growth",
    "status": 1,
    "isVerified": true,
    "setupCompleted": true,
    "authType": "basic",
    "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"
  }
}
```

### 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                                    |
| `user`                | objet   | Objet utilisateur mis à jour                           |
| `user.id`             | chaîne  | Identifiant unique de l'utilisateur                    |
| `user.name`           | chaîne  | Nom complet de l'utilisateur                           |
| `user.username`       | chaîne  | Nom d'utilisateur de l'utilisateur                     |
| `user.email`          | chaîne  | Adresse e-mail de l'utilisateur                        |
| `user.role`           | chaîne  | Rôle de l'utilisateur dans le système                  |
| `user.license`        | chaîne  | Niveau de licence de l'utilisateur                     |
| `user.status`         | entier  | Statut du compte de l'utilisateur (0=inactif, 1=actif) |
| `user.isVerified`     | booléen | Si l'utilisateur est vérifié                           |
| `user.setupCompleted` | booléen | Si la configuration utilisateur est terminée           |
| `user.authType`       | chaîne  | Type d'authentification                                |
| `user.customRole`     | objet   | Informations sur le rôle personnalisé (si attribué)    |
| `user.createdAt`      | chaîne  | Horodatage de création de compte                       |
| `user.updatedAt`      | chaîne  | Horodatage de la dernière mise à jour                  |
| `user.lastActive`     | chaîne  | Horodatage de la dernière activité de l'utilisateur    |

## Exemple d'utilisation

\###JavaScript

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

// Example usage
const userData = {
  name: "John Doe Updated",
  email: "john.updated@example.com",
  role: "user",
  license: "Growth",
  status: 1
};

const result = await updateUser('60a7c8f5e8b4f5001f7a8c23', userData);
console.log(result);
```

\###Python

```python theme={null}
import requests

def update_user(user_id, user_data):
    url = f"https://{customer.name}.hiperai.ai/api/external/users/{user_id}"
    headers = {
        "Authorization": "Bearer sk-your-api-key-here",
        "Content-Type": "application/json"
    }
    
    response = requests.put(url, headers=headers, json=user_data)
    return response.json()

# Example usage
user_data = {
    "name": "John Doe Updated",
    "email": "john.updated@example.com",
    "role": "user",
    "license": "Growth",
    "status": 1
}

result = update_user("60a7c8f5e8b4f5001f7a8c23", user_data)
print(result)
```

### boucle

```bash theme={null}
curl -X PUT "https://{customer.name}.hiperai.ai/api/external/users/60a7c8f5e8b4f5001f7a8c23" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe Updated",
    "email": "john.updated@example.com",
    "role": "user",
    "license": "Growth",
    "status": 1
  }'
```

## Réponses d'erreur

### 400 Requête incorrecte

```json theme={null}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid email format",
    "details": {
      "field": "email",
      "value": "invalid-email"
    }
  }
}
```

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

### 404 Introuvable

```json theme={null}
{
  "success": false,
  "error": {
    "code": "USER_NOT_FOUND",
    "message": "User not found"
  }
}
```

### 409 Conflit

```json theme={null}
{
  "success": false,
  "error": {
    "code": "EMAIL_ALREADY_EXISTS",
    "message": "Email address already in use"
  }
}
```

## Validations et règles métier

* **Valeur de la licence** : doit figurer dans les licences autorisées (`Essential`, `Growth`, `Ultra`, `Early Access`). Les valeurs non valides renvoient 400.
* **Capacité de la licence** : appliquée via `checkLicenseCapacity` ; renvoie 400 lorsque le niveau sélectionné est plein.
* **Garde de rétrogradation de licence** : si le passage à un niveau inférieur réduit le quota d'index personnel, le changement est bloqué lorsque le nombre actuel d'index personnels dépasse `INDEX_QUOTAS[new_license]` ; renvoie 400 avec des conseils explicites.
* **Normalisation des emails** : Minuscules et tronqués avant validation et stockage.
* **Normalisation du nom d'utilisateur** : Minuscules et tronqués avant validation et stockage.
* **Format d'e-mail** : validation regex simple ; les e-mails invalides renvoient 400.
* **Format du nom d'utilisateur** : doit correspondre à `^[a-z0-9.-]{3,30}$` ; les noms d'utilisateur invalides renvoient 400.
* **Unicité** : `email`, `username` et `name` doivent rester uniques ; les conflits reviennent 409.

## Normalisation et stockage

* `email` et `username` sont toujours stockés en minuscules et tronqués.

## Formes d'erreur typiques

### 400 Licence invalide

```json theme={null}
{
  "success": false,
  "error": "Invalid license",
  "message": "License must be one of: Essential, Growth, Ultra, Early Access"
}
```

### 400 Licence indisponible

```json theme={null}
{
  "success": false,
  "error": "License unavailable",
  "message": "No Ultra licenses available (used/limit)"
}
```

\### 400 La rétrogradation de la licence dépasse le quota

```json theme={null}
{
  "success": false,
  "error": "License downgrade exceeds index quota",
  "message": "Cannot change license to Essential: user has 5 personal indexes but Essential allows 2. Remove or reassign 3 index(es) before downgrading."
}
```

### 400 E-mail invalide

```json theme={null}
{
  "success": false,
  "error": "Invalid email",
  "message": "Email format is invalid"
}
```

### 400 Nom d'utilisateur invalide

```json theme={null}
{
  "success": false,
  "error": "Invalid username",
  "message": "Username must be 3-30 chars, lowercase letters, digits, \".\", "-", or \"\""
}
```

### 409 Conflit (unicité)

```json theme={null}
{
  "success": false,
  "error": "Email/Username/Name already exists",
  "message": "A user with this username already exists"
}
```

## Rôles des utilisateurs

| Rôle           | Descriptif           | Autorisations                                      |
| -------------- | -------------------- | -------------------------------------------------- |
| `admin`        | Administrateur       | Accès complet au système                           |
| `user`         | Utilisateur régulier | Accès utilisateur standard                         |
| `globalReader` | Lecteur mondial      | Accès au panneau d'administration en lecture seule |

\## Niveaux de licence

| Niveau         | Descriptif              | Caractéristiques           |
| -------------- | ----------------------- | -------------------------- |
| `Essential`    | Niveau de base          | Fonctionnalités limitées   |
| `Growth`       | Niveau professionnel    | Fonctionnalités améliorées |
| `Ultra`        | Niveau Premium          | Fonctionnalités complètes  |
| `Early Access` | Niveau d'accès anticipé | Fonctionnalités bêta       |

## État du compte

| Statut | Descriptif     |
| ------ | -------------- |
| `0`    | Compte inactif |
| `1`    | Compte actif   |

## Cas d'utilisation

* **Gestion des rôles** : mise à jour des rôles d'utilisateur pour le contrôle d'accès
* **Mises à niveau de licence** : modification des niveaux de licence utilisateur
* **Maintenance du compte** : mise à jour des informations utilisateur et des métadonnées
* **Gestion des statuts** : activation ou suspension des comptes d'utilisateurs
* **Mises à jour du profil** : modification des noms d'utilisateur, des adresses e-mail ou d'autres détails

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

* Seuls les administrateurs peuvent mettre à jour les comptes d'utilisateurs
* Les adresses e-mail doivent être uniques pour tous les utilisateurs
* Les mises à jour des mots de passe sont facultatives et ne seront appliquées que si elles sont fournies
* Les mises à jour des métadonnées sont fusionnées avec les métadonnées existantes
* L'horodatage `updatedAt` est automatiquement mis à jour en cas d'opérations réussies


## OpenAPI

````yaml PUT /users/{userId}
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/{userId}:
    put:
      tags:
        - User Management
      summary: Update User
      description: |
        Update an existing user account. Only accessible by administrators.
      parameters:
        - name: userId
          in: path
          required: true
          description: User ID to update
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: User's full name
                  example: John Doe Updated
                username:
                  type: string
                  description: Unique username
                  example: johndoe_updated
                email:
                  type: string
                  format: email
                  description: User's email address
                  example: john.updated@example.com
                password:
                  type: string
                  description: User's new password (optional)
                  example: newsecurepassword123
                role:
                  type: string
                  enum:
                    - admin
                    - user
                    - globalReader
                  description: User's role
                  example: user
                license:
                  type: string
                  enum:
                    - Essential
                    - Growth
                    - Ultra
                    - Early Access
                  description: User's license tier
                  example: Growth
                status:
                  type: integer
                  enum:
                    - 0
                    - 1
                  description: User status (0=inactive, 1=active)
                  example: 1
                roleId:
                  type: string
                  description: Custom role ID (MongoDB ObjectId)
                  example: 60a7c8f5e8b4f5001f7a8c24
                setupCompleted:
                  type: boolean
                  description: Whether user setup is completed
                  example: true
                isVerified:
                  type: boolean
                  description: Whether user is verified
                  example: true
            example:
              name: John Doe Updated
              email: john.updated@example.com
              role: user
              license: Growth
              status: 1
              setupCompleted: true
              isVerified: true
      responses:
        '200':
          description: User updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: User updated successfully
                  user:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 60a7c8f5e8b4f5001f7a8c23
                      name:
                        type: string
                        example: John Doe Updated
                      username:
                        type: string
                        example: johndoe
                      email:
                        type: string
                        example: john.updated@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
                      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'
        '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'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Email or username 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`

````