Skip to Content
bpms.ai
ReferenceAccess

Get a user

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

Reads one BPMS 3.x user of the tenant of the request, as it is stored.

Authorization

bearer
headerAuthorizationBearer <token>

The token of a session that createSession opened

Path Parameters

userId*integer

Id of the user

Formatint64

Response Body

The user

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 GET 'https://bpms.bpms.work/api/v1/access/users/0'
Example Response
{  "email": "string",  "enabled": true,  "id": 0,  "identification": "string",  "lastName": "string",  "locked": true,  "name": "string",  "passwordChangeRequired": true,  "userName": "string"}