Ferndesk

Benutzer

Help-Center-Benutzer aktualisieren

Aktualisiert einen Help-Center-Benutzer. Wenn attributes angegeben wird, ersetzt dies das vollständige gespeicherte Attributobjekt, das von Zielgruppenregeln für Benutzergruppen verwendet wird.

PATCH /users/{id}

Help-Center-Benutzer aktualisieren

curl --request PATCH \
  --url 'https://api.ferndesk.com/v1/users/{ID}' \
  --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>"
}

Aktualisierter 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 Entwickler-Einstellungen erstellen und verwalten.

Path Parameters

  • id string erforderlich

    Ferndesk Help-Center-Benutzer-ID (hcusr_...). Beispiel: hcusr_01JXYB3S2Y8C

Request Body

application/json
  • email string (email)

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

  • name string | null

    Aktualisierter Anzeigename. Verwenden Sie null, um den Namen zu löschen.

  • attributes object

    Ersatz für gespeicherte Attribute für den Benutzergruppen-Abgleich. Wenn weggelassen, bleiben die Attribute unverändert.

    + 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

    Festlegen, ob der Benutzer deaktiviert ist. Das Deaktivieren eines Benutzers entfernt aktive Sitzungen.

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 Kleinschreibung 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 beibehalten.

  • 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.