Saltar al contenido principal
POST
Crear 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. Debe ser único en Pruff. Se guarda en minúsculas. No puede contener espacios, y solo admite letras sin tilde, dígitos, la @ y los caracteres ._%+-.

Ejemplo:

"ana.perez@example.com"

name
string
requerido

Nombre completo del usuario.

Ejemplo:

"Ana Pérez"

password
string<password>
requerido

Contraseña con la que el usuario ingresa a Pruff.

Ejemplo:

"ContraseñaSegura123!"

active
boolean
predeterminado:false

Indica si el usuario queda activo. Si no lo envías, queda inactivo.

Ejemplo:

true

roleIds
integer[]

Ids de los roles del usuario (no sus nombres). Si no lo envías, el usuario se crea sin roles. Una lista vacía ([]) o null también crea el usuario sin roles.

Roles estándar:

Tu empresa también puede tener roles personalizados con otros ids. 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.

Ejemplo:

Respuesta

Usuario creado.

message
string
requerido

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

Ejemplo:

"User created"