Nutzer einladen

curl --request POST \
  --url https://api.langdock.com/user-management/v1/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {
      "email": "jane.doe@example.com"
    }
  ]
}
'

{
  "status": "success",
  "message": "Invitations processed",
  "successfulInvites": [
    "alice@example.com",
    "bob@example.com"
  ],
  "invalidEmails": []
}

POST

user-management

invite

curl --request POST \
  --url https://api.langdock.com/user-management/v1/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {
      "email": "jane.doe@example.com"
    }
  ]
}
'

{
  "status": "success",
  "message": "Invitations processed",
  "successfulInvites": [
    "alice@example.com",
    "bob@example.com"
  ],
  "invalidEmails": []
}

Mit diesem Endpunkt kannst du programmatisch einen oder mehrere Nutzer in deinen Workspace einladen. Das ist praktisch, um Onboarding-Abläufe, Partner-Integrationen oder die Massenbereitstellung von Nutzern zu automatisieren.

Basis-URL

https://api.langdock.com/user-management/v1/invite

Dedicated DeploymentsErsetze api.langdock.com durch <your-deployment-url>/api/public in allen Anfragen.

Voraussetzungen

API-Schlüssel mit dem Scope USER_MANAGEMENT_API
Der API-Schlüssel muss von einem Workspace-Admin erstellt worden sein

Verhalten

Bereits Mitglied? Wird übersprungen.
Hat eine ausstehende Beitrittsanfrage? Wird automatisch genehmigt.
Ungültige E-Mail-Domain? Wird in invalidEmails aufgeführt, lässt die Anfrage aber nicht fehlschlagen.
SAML deaktiviert? Die Einladungs-E-Mail enthält einen Magic Link für die passwortlose Anmeldung.
SAML aktiviert? Nutzer außerhalb deiner verifizierten Domains bekommen einen Magic Link, wenn Externe Authentifizierung erlauben aktiv ist.

Eine 200-Antwort kann trotzdem invalidEmails enthalten. Dies sind E-Mail-Adressen, die die Formatvalidierung bestanden haben, aber bei tieferen Prüfungen durchgefallen sind (z. B. nicht erreichbare Domain). Prüfe immer sowohl successfulInvites als auch invalidEmails in der Antwort.

Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen und die Sicherheit deiner Anwendungen zu gewährleisten. Weitere Informationen findest du in unserem Guide zu Best Practices für API-Schlüssel.

Autorisierungen

Authorization

string

header

erforderlich

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Body

application/json

users

object[]

erforderlich

List of users to invite. At least one user is required.

Minimum array length: 1

Show child attributes

Antwort

Invitations processed successfully

status

enum<string>

erforderlich

Always "success" when the request is processed

Verfügbare Optionen:

success

Beispiel:

"success"

message

string

erforderlich

Human-readable summary of the result

Beispiel:

"Invitations processed"

successfulInvites

string<email>[]

erforderlich

Email addresses that were successfully invited

Beispiel:

["alice@example.com", "bob@example.com"]

invalidEmails

string[]

erforderlich

Email addresses that failed deeper validation (e.g., unreachable domain)

Beispiel:

[]

⌘I

Überblick

Completion API

Embedding API

Agents API

Assistants API (Deprecating)

Integrations API

Skills API

Knowledge Folder API

Usage Export API

Workflow-Ausführungs-Export-API

User Management API

Audit Logs API

Nutzer einladen

Basis-URL

Voraussetzungen

Verhalten

Autorisierungen

Body

Antwort

​Basis-URL

​Voraussetzungen

​Verhalten

Autorisierungen

Body

Antwort

Basis-URL

Voraussetzungen

Verhalten