• Deutsch
      • KI-Übersetzungshinweis

      Diese Dokumentation wurde automatisch von KI übersetzt.

      Benutzerdaten über die HTTP API synchronisieren

      API-Schlüssel erhalten

      Lesen Sie dazu API-Schlüssel. Stellen Sie sicher, dass die Rolle, die Ihrem API-Schlüssel zugewiesen ist, die erforderlichen Berechtigungen zur Synchronisierung von Benutzerdaten besitzt.

      API-Übersicht

      Beispiel

      curl 'https://localhost:13000/api/userData:push' \
  -H 'Authorization: Bearer <token>' \
  --data-raw '{"dataType":"user","records":[]}' # Den Anfragekörper finden Sie unten ausführlich beschrieben

      Endpunkt

      POST /api/userData:push

      Format der Benutzerdaten

      UserData

      ParameterTypBeschreibung
      dataType'user' | 'department'Erforderlich. Der Typ der zu übertragenden Daten. Verwenden Sie user für die Übertragung von Benutzerdaten.
      matchKey'username' | 'email' | 'phone'Optional. Wird verwendet, um vorhandene Systembenutzer anhand des angegebenen Feldes abzugleichen.
      recordsUserRecord[]Erforderlich. Ein Array von Benutzerdatensätzen.

      UserRecord

      ParameterTypBeschreibung
      uidstringErforderlich. Eindeutiger Bezeichner für die Benutzerdatenquelle, der zur Verknüpfung der Quelldaten mit dem Systembenutzer dient. Für einen Benutzer unveränderlich.
      nicknamestringOptional. Spitzname des Benutzers.
      usernamestringOptional. Benutzername.
      emailstringOptional. E-Mail-Adresse des Benutzers.
      phonestringOptional. Telefonnummer des Benutzers.
      departmentsstring[]Optional. Array der UIDs der Abteilungen, zu denen der Benutzer gehört.
      isDeletedbooleanOptional. Zeigt an, ob der Datensatz gelöscht wurde.
      <field>anyOptional. Benutzerdefinierte Felder in der Benutzertabelle.

      Format der Abteilungsdaten

      Info

      Um Abteilungsdaten zu übertragen, muss das Abteilungen Plugin installiert und aktiviert sein.

      DepartmentData

      ParameterTypBeschreibung
      dataType'user' | 'department'Erforderlich. Der Typ der zu übertragenden Daten. Verwenden Sie department für Abteilungsdaten.
      recordsDepartmentRecord[]Erforderlich. Ein Array von Abteilungsdatensätzen.

      DepartmentRecord

      ParameterTypBeschreibung
      uidstringErforderlich. Eindeutiger Bezeichner für die Abteilungsdatenquelle, der zur Verknüpfung der Quelldaten mit der Systemabteilung dient. Unveränderlich.
      titlestringErforderlich. Titel der Abteilung.
      parentUidstringOptional. UID der übergeordneten Abteilung.
      isDeletedbooleanOptional. Zeigt an, ob der Datensatz gelöscht wurde.
      <field>anyOptional. Benutzerdefinierte Felder in der Abteilungstabelle.

      :::info

      1. Das mehrfache Übertragen von Daten ist idempotent.
      2. Wenn eine übergeordnete Abteilung beim Übertragen von Abteilungsdaten noch nicht existiert, kann keine Verknüpfung hergestellt werden. Sie können die Daten erneut übertragen, nachdem die übergeordnete Abteilung erstellt wurde.
      3. Wenn die Abteilung eines Benutzers beim Übertragen von Benutzerdaten noch nicht existiert, kann der Benutzer dieser Abteilung nicht zugeordnet werden. Sie können die Benutzerdaten erneut übertragen, nachdem die Abteilungsdaten übertragen wurden. :::