Ferndesk

Usuarios

Crear usuario del centro de ayuda

Crea un usuario del centro de ayuda y almacena los atributos utilizados por las reglas de audiencia de grupos de usuarios. El correo electrónico se normaliza a minúsculas.

POST /users

Crear usuario del centro de ayuda

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

Usuario del centro de ayuda creado

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API tienen el prefijo fdsk_ y deben mantenerse en secreto. Puede generar y administrar claves desde la página de Configuración de desarrolladores.

Request Body

application/json
  • email string (email) obligatorio

    Dirección de correo electrónico del usuario del centro de ayuda. Los correos electrónicos se almacenan en minúsculas.

  • name string | null

    Nombre de visualización opcional para el usuario.

  • attributes object default

    Atributos iniciales guardados para la coincidencia de grupos de usuarios. 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

    Crear el usuario deshabilitado. Default: false.

Response

application/json
  • id string

    ID de usuario del centro de ayuda de Ferndesk (hcusr_...).

  • helpdeskId string

    ID de helpdesk de Ferndesk (help_...).

  • email string (email)

    Dirección de correo electrónico del usuario del centro de ayuda. Los correos electrónicos se almacenan en minúsculas.

  • name string | null

    Nombre de visualización para el usuario del centro de ayuda.

  • emailVerified boolean

    Indica si el correo electrónico ha sido verificado a través de un flujo de autenticación del centro de ayuda.

  • disabled boolean

    Indica si el usuario está deshabilitado. Los usuarios deshabilitados no pueden mantener sesiones activas.

  • attributes object

    Atributos de usuario guardados utilizados por las reglas de grupos de usuarios. Los valores pueden ser cadenas, números, booleanos o matrices de un tipo primitivo.

    + 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

    Marca de tiempo del inicio de sesión más reciente en el centro de ayuda, si existe.

  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.