Ferndesk

Usuarios

Actualizar usuario del centro de ayuda

Actualiza un usuario del centro de ayuda. Cuando se proporciona attributes, reemplaza el objeto de atributos guardados completo utilizado por las reglas de audiencia de grupos de usuarios.

PATCH /users/{id}

Actualizar usuario del centro de ayuda

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

Usuario del centro de ayuda actualizado

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.

Path Parameters

  • id string obligatorio

    ID de usuario del centro de ayuda de Ferndesk (hcusr_...). Ejemplo: hcusr_01JXYB3S2Y8C

Request Body

application/json
  • 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 pantalla actualizado. Use null para borrar el nombre.

  • attributes object

    Atributos guardados de reemplazo para la coincidencia de grupos de usuarios. Si se omite, los atributos no cambian.

    + 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

    Establece si el usuario está deshabilitado. Deshabilitar a un usuario elimina las sesiones activas.

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