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

# Neuen Benutzer erstellen

> Create a new user account. Only accessible by administrators.


# Neuen Benutzer erstellen

Erstellen Sie ein neues Benutzerkonto. Nur für Administratoren zugänglich.

## Endpunkt

```
POST /users
```

## Beschreibung

Dieser Endpunkt ermöglicht Administratoren das Erstellen neuer Benutzerkonten im System. Sie können verschiedene Benutzerattribute angeben, einschließlich Rolle, Lizenz und Authentifizierungstyp. Dies ist ein administrativer Endpunkt, der entsprechende Berechtigungen erfordert.

## Benutzererstellungsablauf

**Basic Auth** (`authType: "basic"`): Der Benutzer erhält eine Willkommens-E-Mail mit einem Link zur Passworteinrichtung. Das Konto wird unbestätigt erstellt, bis das Passwort festgelegt wird.

**Enterprise SSO** (`authType: "enterprise"`): Der Benutzer wird verifiziert erstellt und kann sich über Enterprise SSO (Auth0, Microsoft AD usw.) anmelden. Keine Passwort-Einrichtung erforderlich.

## Authentifizierung

Erforderlich. Fügen Sie Ihren API-Schlüssel in den Autorisierungsheader ein.

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

## Anfrage

### Anforderungstext

| Parameter        | Geben Sie       | ein Erforderlich | Standard   | Beschreibung                                                                                |
| ---------------- | --------------- | ---------------- | ---------- | ------------------------------------------------------------------------------------------- |
| `name`           | Zeichenfolge    | Ja               | -          | Vollständiger Name des Benutzers                                                            |
| `username`       | Zeichenfolge    | Nein             | -          | Eindeutiger Benutzername (wird automatisch aus der E-Mail generiert, falls nicht angegeben) |
| `email`          | Zeichenfolge    | Ja               | -          | E-Mail-Adresse des Benutzers                                                                |
| `role`           | Zeichenfolge    | Nein             | Benutzer   | Benutzerrolle (Administrator, Benutzer, globalReader)                                       |
| `license`        | Zeichenfolge    | Nein             | Wesentlich | Lizenzstufe des Benutzers (Essential, Growth, Ultra, Early Access)                          |
| `roleId`         | Zeichenfolge    | Nein             | -          | Benutzerdefinierte Rollen-ID (MongoDB ObjectId)                                             |
| `setupCompleted` | boolescher Wert | Nein             | falsch     | Ob die Benutzereinrichtung abgeschlossen ist                                                |
| `authType`       | Zeichenfolge    | Nein             | einfach    | Authentifizierungstyp (Basis, Unternehmen)                                                  |

### Beispielanfrage

```bash theme={null}
curl -X POST "https://{customer.name}.hiperai.ai/api/external/users" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "username": "johndoe",
    "email": "john@example.com",
    "role": "user",
    "license": "Growth",
    "setupCompleted": false,
    "authType": "enterprise"
  }'
```

## Antwort

### Erfolgsantwort (201)

```json theme={null}
{
  "success": true,
  "message": "User created successfully",
  "user": {
    "id": "60a7c8f5e8b4f5001f7a8c23",
    "name": "John Doe",
    "username": "johndoe",
    "email": "john@example.com",
    "role": "user",
    "license": "Growth",
    "status": 1,
    "isVerified": false,
    "setupCompleted": false,
    "authType": "basic",
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}
```

### Antwortfelder

| Feld                  | Geben Sie       | ein Beschreibung                             |
| --------------------- | --------------- | -------------------------------------------- |
| `success`             | boolescher Wert | Immer `true` für erfolgreiche Anfragen       |
| `message`             | Zeichenfolge    | Erfolgsmeldung                               |
| `user`                | Objekt          | Erstelltes Benutzerobjekt                    |
| `user.id`             | Zeichenfolge    | Eindeutige Kennung des Benutzers             |
| `user.name`           | Zeichenfolge    | Vollständiger Name des Benutzers             |
| `user.username`       | Zeichenfolge    | Benutzername des Benutzers                   |
| `user.email`          | Zeichenfolge    | E-Mail-Adresse des Benutzers                 |
| `user.role`           | Zeichenfolge    | Benutzerrolle                                |
| `user.license`        | Zeichenfolge    | Lizenzstufe des Benutzers                    |
| `user.status`         | Ganzzahl        | Benutzerstatus (1=aktiv)                     |
| `user.isVerified`     | boolescher Wert | Ob der Benutzer verifiziert ist              |
| `user.setupCompleted` | boolescher Wert | Ob die Benutzereinrichtung abgeschlossen ist |
| `user.authType`       | Zeichenfolge    | Authentifizierungstyp                        |
| `user.createdAt`      | Zeichenfolge    | Zeitstempel der Benutzererstellung           |

## Beispielverwendung

### JavaScript

```javascript theme={null}
const response = await fetch('https://{customer.name}.hiperai.ai/api/external/users', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'John Doe',
    username: 'johndoe',
    email: 'john@example.com',
    role: 'user',
    license: 'Growth'
  })
});

const data = await response.json();

if (data.success) {
  console.log('User created:', data.user.name);
  console.log('User ID:', data.user.id);
}
```

### Python

```python theme={null}
import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
}

data = {
    'name': 'John Doe',
    'username': 'johndoe',
    'email': 'john@example.com',
    'role': 'user',
    'license': 'Growth'
}

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

if result['success']:
    print('User created:', result['user']['name'])
    print('User ID:', result['user']['id'])
```

### cURL

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

## Fehlerantworten

### 400 Ungültige Anfrage

```json theme={null}
{
  "success": false,
  "error": "Invalid request parameters",
  "message": "The 'name' field is required"
}
```

### 400 Ungültiger AuthType

```json theme={null}
{
  "success": false,
  "error": "Invalid authType",
  "message": "authType must be either \"basic\" or \"enterprise\""
}
```

### 400 Pflichtfelder fehlen

```json theme={null}
{
  "success": false,
  "error": "Missing required fields",
  "message": "Name and email are required"
}
```

### 401 Nicht autorisiert

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

### 403 Verboten

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

### 409 Konflikt

```json theme={null}
{
  "success": false,
  "error": "User already exists",
  "message": "A user with this email already exists"
}
```

## Validierungen und Geschäftsregeln

* **Lizenzwert**: Muss eine der zulässigen Lizenzen sein (`Essential`, `Growth`, `Ultra`, `Early Access`). Ungültige Werte geben 400 zurück.
* **Lizenzkapazität**: Durchgesetzt über `checkLicenseCapacity`. Wenn die Kapazität für die ausgewählte Ebene voll ist, wird 400 zurückgegeben.
* **E-Mail-Normalisierung**: Vor der Validierung und Speicherung in Kleinbuchstaben geschrieben und gekürzt.
* **Normalisierung des Benutzernamens**: Vor der Validierung und Speicherung in Kleinbuchstaben geschrieben und gekürzt. Wird automatisch aus der E-Mail generiert, sofern nicht angegeben.
* **E-Mail-Format**: Validiert mit einem einfachen regulären Ausdruck; Ungültige E-Mails geben 400 zurück.
* **Benutzernamenformat**: Muss mit `^[a-z0-9.-]{3,30}$` übereinstimmen; Ungültige Benutzernamen geben 400 zurück.
* **Einzigartigkeit**: `email`, `username` und `name` müssen eindeutig sein. Konflikte geben 409 zurück.
* **Verhalten bei E-Mail-Einladungen**: Bei der Basisauthentifizierung erhalten Benutzer Willkommens-E-Mails mit Links zur Passworteinrichtung.

## Normalisierung und Speicherung

* `email` und `username` werden immer in Kleinbuchstaben und gekürzt gespeichert.

## Typische Fehlerformen

### 400 Ungültige Lizenz

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

### 400-Lizenz nicht verfügbar

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

### 400 Ungültige E-Mail

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

### 400 Ungültiger Benutzername

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

### 409 Konflikt (Einzigartigkeit)

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

## Benutzerrollen

| Rolle          | Beschreibung      | Berechtigungen                         |
| -------------- | ----------------- | -------------------------------------- |
| `admin`        | Administrator     | Voller Systemzugriff                   |
| `user`         | Normaler Benutzer | Standardbenutzerzugriff                |
| `globalReader` | Globaler Leser    | Schreibgeschützter Admin-Panel-Zugriff |

## Lizenzstufen

| Lizenz         | Beschreibung         | Funktionen                |
| -------------- | -------------------- | ------------------------- |
| `Essential`    | Grundstufe           | Eingeschränkte Funktionen |
| `Growth`       | Professionelle Stufe | Erweiterte Funktionen     |
| `Ultra`        | Premium-Stufe        | Vollständige Funktionen   |
| `Early Access` | Early-Access-Stufe   | Beta-Funktionen           |

## Authentifizierungstypen

| Geben Sie    | ein Beschreibung                                                                         |
| ------------ | ---------------------------------------------------------------------------------------- |
| `basic`      | Benutzername/Passwort-Authentifizierung (Benutzer erhält E-Mail zur Passworteinrichtung) |
| `enterprise` | Enterprise SSO-Integration (Auth0, Microsoft AD usw.)                                    |

## Anwendungsfälle

* **Benutzer-Onboarding**: Erstellen Sie neue Benutzerkonten für Teammitglieder
* **Passwortloses Onboarding**: Erstellen Sie Benutzer, die E-Mail-Einladungen erhalten, um ihre eigenen Passwörter festzulegen
* **SSO-Integration**: Erstellen Sie Benutzer, die sich über externe Identitätsanbieter authentifizieren
* **Massenbenutzererstellung**: Erstellen Sie programmgesteuert mehrere Benutzer
* **Integration**: Benutzer aus externen Systemen erstellen
* **Administrative Aufgaben**: Benutzerkonten über die API verwalten

## Tarifbegrenzungen

Dieser Endpunkt folgt den Standardratenbegrenzungen:

* 60 Anfragen pro Minute
* 1000 Anfragen pro Stunde


## OpenAPI

````yaml POST /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:
    post:
      tags:
        - User Management
      summary: Create New User
      description: |
        Create a new user account. Only accessible by administrators.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - username
                - email
                - password
              properties:
                name:
                  type: string
                  description: User's full name
                  example: John Doe
                username:
                  type: string
                  description: Unique username
                  example: johndoe
                email:
                  type: string
                  format: email
                  description: User's email address
                  example: john@example.com
                password:
                  type: string
                  description: User's password
                  example: securepassword123
                role:
                  type: string
                  enum:
                    - admin
                    - user
                    - globalReader
                  default: user
                  description: User's role
                  example: user
                license:
                  type: string
                  enum:
                    - Essential
                    - Growth
                    - Ultra
                    - Early Access
                  default: Essential
                  description: User's license tier
                  example: Growth
                roleId:
                  type: string
                  description: Custom role ID (MongoDB ObjectId)
                  example: 60a7c8f5e8b4f5001f7a8c24
                setupCompleted:
                  type: boolean
                  default: false
                  description: Whether user setup is completed
                  example: false
                authType:
                  type: string
                  enum:
                    - basic
                    - auth0
                  default: basic
                  description: Authentication type
                  example: basic
            example:
              name: John Doe
              username: johndoe
              email: john@example.com
              password: securepassword123
              role: user
              license: Growth
              setupCompleted: false
              authType: basic
      responses:
        '201':
          description: User created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: User created successfully
                  user:
                    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: false
                      authType:
                        type: string
                        example: basic
                      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: User 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`

````