Wie importiere ich eine Liste von Benutzern mit der Flexopus-API?

In diesem Artikel erfahren Sie, wie Sie ein API-Token erstellen und damit eine vollständige Benutzerliste in einem Tabellenkalkulationsformat importieren können.

Erzeugen eines API-Tokens

Als Systemadministrator gehen Sie auf das Administrator-Dashboard und wählen im Menü "Einstellungen" den Punkt "Single Sign On / Integrationen". Hier können Sie im Bereich "Flexopus API" ein Token für unsere API generieren.

Benutzer über den API-Endpunkt importieren

Verwenden Sie den folgenden Endpunkt:

POST /api/v1/users/import

Der Endpunkt verwendet das oben generierte Bearer Token zur Authentifizierung und akzeptiert mehrteilige Daten als Eingabe:

• Datei: Datei; erforderlich; akzeptierte Dateiformate: csv, txt, ods, xls, xlsx; sollte die zu importierende Benutzerliste enthalten
  ℹ️ Die erwartete Dateistruktur und eine Beispieldatei finden Sie unter dem Link am Ende dieser Seite.
• update: boolean; Standardwert false; bestimmt, ob bestehende Benutzer aktualisiert werden sollen
• deactivate: boolean; Standardwert false; legt fest, ob nicht in der Liste vorhandene Benutzer deaktiviert werden sollen
• restore: boolean; Standardwert false; bestimmt, ob deaktivierte Benutzer in der Liste wieder aktiviert werden sollen

{
  "dryRun": false,         // dry_run flag from the request
  "created": [2, 3],       // row indices for freshly created users
  "updated": [4, 6],       // row indices for updated users
  "deleted": 0,            // the number of deleted users
  "skipped": [5, 8],       // row indices for unchanged users
  "errors": [7],           // indices for rows with errors
  "errorMessages": {       // object with messages for every error
    "7": {                     // row index of error
      "email": [                   // column with error
        "The email must be a valid email address." // error message
      ]
    }
  },
  "rows": 7,              // total number of processed rows
  "filename": "users.csv" // name of the uploaded file
}

curl https://<your-domain>.flexopus.com/api/v1/users/import \
    -H "Accept: application/json" \
    -H "Authorization: Bearer <your-token>" \
    -F "file=@./users.csv" \
    -F "update=1" \
    -F "deactivate=1" \
    -F "restore=1" \
    -F "dry_run=0"

R0076