Skip to Content
bpms.ai
ReferenceAccess

Update a user

PATCH
/api/v1/access/users/{userId}

Changes the fields of a BPMS 3.x user of the tenant of the request that the body carries, with the rules of creating a user, as the 3.x user form does; an absent field is left as it is. Requires 6.2.2.2 (edit users). A body that changes nothing writes nothing. The roles, the password, and the status have their own operations.

Authorization

bearer
headerAuthorizationBearer <token>

The token of a session that createSession opened

Path Parameters

userId*integer

Id of the user

Formatint64

Request Body

The fields to change

application/json
  1. body
email?|

Up to 255 characters; an empty one removes it unless bpms.access.users.email-required is on, which also makes it unique in the tenant

identification?|

Up to 15 letters and digits; unique in the tenant

lastName?|

Up to 255 characters

name?|

Up to 255 characters

userName?|

The name the user logs in with, up to 255 characters; unique in any case

Response Body

The user as stored after the update

application/json
  1. response
email?string|null
enabled?boolean

False when the user is disabled; a stored NULL reads as false

id?integer
Formatint64
identification?string
lastName?string
locked?boolean

True once the failed logins exceed the configured maximum

name?string
passwordChangeRequired?boolean

True when the user must change the password at the next login

userName?string

The name the user logs in with

Example Request
curl -X PATCH 'https://bpms.bpms.work/api/v1/access/users/0' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "email": "string",  "enabled": true,  "id": 0,  "identification": "string",  "lastName": "string",  "locked": true,  "name": "string",  "passwordChangeRequired": true,  "userName": "string"}