Ferndesk

Benutzer

Help-Center-Benutzer erstellen

Erstellt einen Help-Center-Benutzer und speichert Attribute, die für Zielgruppenregeln von Benutzergruppen verwendet werden. Die E-Mail-Adresse wird in Kleinbuchstaben normalisiert.

POST /users

Help-Center-Benutzer erstellen

curl --request POST \
  --url 'https://api.ferndesk.com/v1/users' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "helpdeskId": "<string>",
  "email": "<email>",
  "name": "<string>",
  "emailVerified": true,
  "disabled": true,
  "attributes": {
    "key": "<string>"
  },
  "lastLoginAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Erstellter Help-Center-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 Entwicklereinstellungen erstellen und verwalten.

Request Body

application/json
  • email string (email) erforderlich

    E-Mail-Adresse des Help-Center-Benutzers. E-Mails werden in Kleinbuchstaben gespeichert.

  • name string | null

    Optionaler Anzeigename für den Benutzer.

  • attributes object default

    Initial gespeicherte Attribute für den Abgleich von Benutzergruppen. Default: {}.

    + 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
  • disabled boolean default

    Benutzer deaktiviert erstellen. Default: false.

Response

application/json
  • id string

    Ferndesk Help-Center-Benutzer-ID (hcusr_...).

  • helpdeskId string

    Ferndesk Helpdesk-ID (help_...).

  • email string (email)

    E-Mail-Adresse des Help-Center-Benutzers. E-Mails werden in Kleinbuchstaben gespeichert.

  • name string | null

    Anzeigename für den Help-Center-Benutzer.

  • emailVerified boolean

    Gibt an, ob die E-Mail über einen Help-Center-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 Benutzergruppenregeln 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 Help-Center-Anmeldung, falls vorhanden.

  • createdAt string

    ISO 8601-Zeitstempel in UTC.

  • updatedAt string

    ISO 8601-Zeitstempel in UTC.