Saltar al contenido principal
PATCH
Editar usuario

Autorizaciones

x-api-key
string
header
requerido

API key que Pruff entrega a tu empresa.

Cuerpo

application/json
email
string<email>
requerido

Email del usuario que quieres editar. Identifica al usuario y no se modifica.

Ejemplo:

"ana.perez@example.com"

name
string

Nuevo nombre del usuario.

Ejemplo:

"Ana Pérez Soto"

password
string<password>

Nueva contraseña del usuario.

Ejemplo:

"NuevaContraseña456!"

active
boolean

Activa (true) o desactiva (false) al usuario. En un usuario de tu empresa, false desactiva al usuario. En un usuario de otra empresa con acceso a la tuya (invitado), solo activa o desactiva su acceso a tu empresa y no modifica al usuario en su propia empresa. Puedes enviarlo solo, sin otros campos. Debe ser un booleano; si es lo único que envías y no es un booleano, la solicitud responde 400.

Ejemplo:

true

roleIds
integer[]

Ids de los roles del usuario. Reemplaza todos los roles que tenía. Una lista vacía ([]) es válida y deja al usuario sin roles; null se trata como si no lo enviaras. Usa los mismos ids que en POST /user/create:

Tu empresa también puede tener roles personalizados con otros ids. Envía solo ids de roles de tu empresa. Si roleIds no es una lista, incluye un id que no existe en tu empresa o un valor que no es un entero, la solicitud responde 400 Invalid roleIds. Los roles de administrador (el id 1, el id 4 reservado de Pruff y cualquier rol personalizado con permisos de administrador) no se pueden asignar por API: la solicitud responde 400 con el displayMessage No se pueden asignar roles de administrador por API. Si el usuario ya tiene un rol de administrador, enviar roleIds responde 403 y no modifica nada.

Ejemplo:

Respuesta

Usuario actualizado.

message
string
requerido

Confirmación de la operación (User created o User updated).

Ejemplo:

"User created"