Ferndesk

Utilisateurs

Créer un utilisateur du centre d'aide

Crée un utilisateur du centre d'aide et stocke les attributs utilisés par les règles d'audience des groupes d'utilisateurs. L'e-mail est normalisé en minuscules.

POST /users

Créer un utilisateur du centre d'aide

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>"
}

Utilisateur du centre d'aide créé

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.

Request Body

application/json
  • email string (email) requis

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

  • name string | null

    Nom d'affichage facultatif pour l'utilisateur.

  • attributes object default

    Attributs enregistrés initiaux pour la correspondance des groupes d'utilisateurs. 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

    Créer l'utilisateur en mode désactivé. Default: false.

Response

application/json
  • id string

    Identifiant de l'utilisateur du centre d'aide Ferndesk (hcusr_...).

  • helpdeskId string

    Identifiant 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 groupes 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.