Skip to Content
bpms.ai
ReferenceAccess

Create a user

POST
/api/v1/access/users

Creates a BPMS 3.x user of the tenant of the request with its roles, as the 3.x user form does; the password is stored as Argon2id. Requires 6.2.2.1 (create users) and every authority of the requested roles.

Authorization

bearer
headerAuthorizationBearer <token>

The token of a session that createSession opened

Request Body

The new user

application/json
  1. body
email?|

Up to 255 characters; required and unique in the tenant only when bpms.access.users.email-required is on

enabled?boolean

Whether the user may log in; true when absent

Defaulttrue
identification?string

Up to 15 letters and digits; unique in the tenant

lastName?string

Up to 255 characters

locked?boolean

Whether the user starts locked, as after too many failed logins, until it is unlocked; false when absent. The dashboard shows this box checked: that default is the dashboard's, not the API's

Defaultfalse
mustChangePassword?boolean

Whether the user must change the password at the next login; true when absent

Defaulttrue
name?string

Up to 255 characters

password?string

Must follow the password policy; stored as Argon2id

roleIds?array<>

Ids of the roles of the tenant, at least one; the caller must hold every authority of each

userName?string

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

Response Body

The created user; Location names it

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 POST 'https://bpms.bpms.work/api/v1/access/users' \  -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"}