Ferndesk

Benutzer

Hilfecenter-Benutzer auflisten

Gibt Hilfecenter-Benutzer für Ihre Organisation zurück. Verwenden Sie den optionalen E-Mail-Filter, um einen bestimmten Benutzer zu suchen, bevor Sie gespeicherte Attribute aktualisieren.

GET /users

Hilfecenter-Benutzer auflisten

curl --request GET \
  --url 'https://api.ferndesk.com/v1/users' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "items": [
    {
      "id": "<string>",
      "helpdeskId": "<string>",
      "email": "<email>",
      "name": "<string>",
      "emailVerified": true,
      "disabled": true,
      "attributes": {},
      "lastLoginAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

Paginierte Hilfecenter-Benutzer

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel haben das Präfix fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel auf der Seite Entwickler-Einstellungen erstellen und verwalten.

Query Parameters

  • email string (email)

    Optionaler Filter für exakte E-Mail-Übereinstimmung. Die Groß-/Kleinschreibung wird nicht berücksichtigt. Beispiel: [email protected]

  • limit integer

    Maximale Anzahl der zurückzugebenden Elemente (1-100). Beispiel: 20

  • offset integer

    Anzahl der zu überspringenden Elemente vor dem Sammeln der Ergebnisse. Beispiel: 0

Response

application/json
  • items[] object array

    Elemente der aktuellen Seite. Hilfecenter-Benutzer-Payload.

    + Show Child Attributes
    • id string

      Ferndesk Hilfecenter-Benutzer-ID (hcusr_...).

    • helpdeskId string

      Ferndesk Helpdesk-ID (help_...).

    • email string (email)

      E-Mail-Adresse des Hilfecenter-Benutzers. E-Mails werden in Kleinschreibung gespeichert.

    • name string | null

      Anzeigename für den Hilfecenter-Benutzer.

    • emailVerified boolean

      Gibt an, ob die E-Mail über einen Hilfecenter-Authentifizierungs-Flow verifiziert wurde.

    • disabled boolean

      Gibt an, ob der Benutzer deaktiviert ist. Deaktivierte Benutzer können keine aktiven Sitzungen aufrechterhalten.

    • attributes object

      Gespeicherte Benutzerattribute, die von Benutzergruppen-Regeln verwendet werden. Werte können Zeichenfolgen, Zahlen, Booleans oder Arrays eines primitiven Typs sein.

      + Show Child Attributes
      • [key: string] anyOf additional
        + Show Child Attributes
        • anyOf options 4 variants anyOf

          One or more options can apply.

          + Show Child Attributes
          • option 1 string | number | boolean
          • option 2 array
            + Show Child Attributes
            • items[] string array item
          • option 3 array
            + Show Child Attributes
            • items[] number array item
          • option 4 array
            + Show Child Attributes
            • items[] boolean array item
    • lastLoginAt string | null

      Zeitstempel der letzten Hilfecenter-Anmeldung, falls vorhanden.

    • createdAt string

      ISO 8601 Zeitstempel in UTC.

    • updatedAt string

      ISO 8601 Zeitstempel in UTC.

  • limit integer

    Für diese Antwort verwendete Seitengröße.

  • offset integer

    Anzahl der übersprungenen Datensätze für diese Seite.

  • total integer

    Gesamtzahl der übereinstimmenden Datensätze über alle Seiten hinweg.