Saltar a la navegación

Actualizar Detalles del Usuario

Ver como Markdown

Actualiza la información del usuario para el usuario especificado por el ID del empleado.

Puede encontrar el ID del empleado (personId) utilizando el punto final GET List Company Users /v2/employment.

Los cambios se definen en el cuerpo de la solicitud. Solo incluya los atributos que desea actualizar.

Los atributos tienen estos valores.

  • notificationEnabled - (Booleano) - Configuración de notificación del usuario.
  • position - (Cadena) Rol del usuario. Para obtener más información sobre roles, consulte POST Invite (Agregar) un nuevo usuario a una empresa existente.
  • newsletter - (Booleano) - Configuración de boletín del usuario.
  • promotions - (Booleano) - Configuración de promociones del usuario.
  • firstName - (Cadena) Nombre del usuario.
  • lastName - (Cadena) Apellido del usuario.
  • phone - (Cadena) Número de teléfono del usuario.
  • requireTotp - (Booleano) Define si el usuario requiere una contraseña de un solo uso basada en tiempo.
  • active - (Booleano) Establezca este valor en true si el usuario está activo o establézcalo en false para definir al usuario como Inactivo.
  • securityRoles - (Matriz de cadenas) Roles de seguridad del usuario. Por ejemplo, companyAdmin, technicalContact.
  • mobile - (Cadena) Número de teléfono móvil del usuario.
  • email - (Cadena) Dirección de correo electrónico del usuario.
  • partyId - (Cadena) - ID de empleado del usuario. Igual que personId.
  • altId - (Cadena) ID de Google del usuario.
  • username - (Cadena) - Nombre de usuario del usuario.
  • uid - (Cadena) - Uid del usuario.
  • googlePlus - (Cadena) Enlace de Google del usuario.
  • salesforceId - (Cadena) ID de Salesforce del usuario.
  • name - (Cadena) - Nombre completo del usuario.
  • emails - (Matriz de objetos (Correo electrónico)) Objeto de correo electrónico del usuario.
    • emailAddressId (Entero) - ID de dirección de correo electrónico.
    • email (Cadena) - Dirección de correo electrónico.
    • primary (Booleano) - Define si el correo electrónico es la dirección de correo electrónico principal del usuario.
    • badEmail (Booleano) - ¿Está el correo electrónico en el formato correcto?

Parámetros de ruta

employeeIdstringRequerido

Solicitud

This endpoint expects a list of objects.
activebooleanOpcional
altIdstringOpcional
emailstringOpcional
emailslist of objectsOpcional
featureFlagslist of anyOpcional
firstNamestringOpcional
googlePlusstringOpcional
lastNamestringOpcional
mobilestringOpcional
namestringOpcional
newsletterbooleanOpcional
notificationEnabledbooleanOpcional
partyIddoubleOpcional
phonestringOpcional
positionstringOpcional
promotionsbooleanOpcional
requireTotpbooleanOpcional
salesforceIdstringOpcional
securityRoleslist of stringsOpcional
uidstringOpcional
usernamestringOpcional

Respuesta

Actualizar Detalles de Usuario - Éxito / Actualizar Detalles de Usuario - Éxito

messagestringOpcional
termsstringOpcional

Errores

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error