Ferndesk

Utilisateurs

Lister les utilisateurs du centre d'aide

Renvoie les utilisateurs du centre d'aide pour votre organisation. Utilisez le filtre d'e-mail facultatif pour rechercher un utilisateur spécifique avant de mettre à jour les attributs enregistrés.

GET /users

Lister les utilisateurs du centre d'aide

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
}

Utilisateurs du centre d'aide paginés

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un jeton Bearer dans l'en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page des Paramètres développeur.

Query Parameters

  • email string (email)

    Filtre d'e-mail exact facultatif. La correspondance n'est pas sensible à la casse. Exemple: [email protected]

  • limit integer

    Nombre maximum d'éléments à renvoyer (1-100). Exemple: 20

  • offset integer

    Nombre d'éléments à ignorer avant de collecter les résultats. Exemple: 0

Response

application/json
  • items[] object array

    Éléments de la page actuelle. Charge utile de l'utilisateur du centre d'aide.

    + Show Child Attributes
    • id string

      ID utilisateur du centre d'aide Ferndesk (hcusr_...).

    • helpdeskId string

      ID du helpdesk Ferndesk (help_...).

    • email string (email)

      Adresse e-mail de l'utilisateur du centre d'aide. Les e-mails sont stockés en minuscules.

    • name string | null

      Nom d'affichage de l'utilisateur du centre d'aide.

    • emailVerified boolean

      Indique si l'e-mail a été vérifié via un flux d'authentification du centre d'aide.

    • disabled boolean

      Indique si l'utilisateur est désactivé. Les utilisateurs désactivés ne peuvent pas maintenir de sessions actives.

    • attributes object

      Attributs utilisateur enregistrés utilisés par les règles de groupe d'utilisateurs. Les valeurs peuvent être des chaînes, des nombres, des booléens ou des tableaux d'un type primitif.

      + 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

      Horodatage de la connexion la plus récente au centre d'aide, le cas échéant.

    • createdAt string

      Horodatage ISO 8601 en UTC.

    • updatedAt string

      Horodatage ISO 8601 en UTC.

  • limit integer

    Taille de page utilisée pour cette réponse.

  • offset integer

    Nombre d'enregistrements ignorés pour cette page.

  • total integer

    Nombre total d'enregistrements correspondants sur toutes les pages.