3.1 - REST API Administration - Users

Users

The following REST endpoints are used to manage users in ProcessMaker.

Get Users List: GET /users

Returns a list of all users in the workspace, including users with "INACTIVE" and "VACATION" status. The users are returned in the order which they appear in the wf_<WORKSPACE>.USERS table.

GET /api/1.0/{workspace}/users?filter={filter}&start={start}&limit={limit}

URL Parameters:

Name	Type	Description
workspace	String	Workspace name

Optional GET Parameters:

Name	Type	Description
filter	string	Case insensitive string to search for in the user's first name, last name or username. For example, "api/1.0/workspace/users?filter=mit" would return the users "smith", "Mitter" and "solmit".
start	integer	The number of users where the list begins. The counting starts from number 0, which is always the "admin" user. For example, "api/1.0/workspace/users?start=3" would start the list of users with the fourth user.
limit	integer	The maximum number of users which are returned in the list. For example if wanting to return 10 users at a time and there are 25 users in total, then call this endpoint 3 times: "api/1.0/workspace/users?limit=10" (returns users 0-9) "api/1.0/workspace/users?start=10&limit=10" (returns users 10-19) "api/1.0/workspace/users?start=20&limit=10" (returns users 20-24)

Result:

If a successful request, the HTTP status code is 200 and it returns a JSON array of user objects with the following structure:

If a bad request, than the HTTP status code is set to 400 or greater and it returns a JSON error object.

Example in JavaScript:
This JavaScript example creates a array of active users. It obtains the list of all the users for the workspace and stores it in an array named aUsers. Then it loops through the array and checks whether the user's status is "ACTIVE". If so, it adds the user's UID and username to an new array named aActiveUsers.

Example in PHP:

This PHP example creates a array of active users. It obtains the list of all the users for the workspace and stores it in an array named $aUsers. Then it loops through the array and checks whether the user's status is "ACTIVE". If so, it adds the user's UID and username to an new array named $aActiveUsers.

Get User Information: GET /user/{usr_uid}

Get information about a specified user.

GET /api/1.0/{workspace}/user/{usr_uid}

URL Parameters:

Name	Type	Description
workspace	String	Workspace name
usr_uid	String	User UID

Result:

Returns the HTTP status code 200 and the same user object as the GET /users endpoint. For example:

If a bad request, then it returns the HTTP status code 400 and an error object like the following:

Example in PHP:

Create User: POST /user

Create a new user.

Permission:

The logged-in user needs to have the PM_USERS permission in his/her role in order to be able to perform this action.

Structure:

POST /api/1.0/{workspace}/user

URL Parameters:

Name	Type	Description
workspace	String	Workspace name

POST Parameters:

Name	Type	Description
usr_username	String	Username which is used to login to ProcessMaker and is unique.
usr_firstname	String	User's first name
usr_lastname	String	User's last name
usr_email	String	User's email address
usr_due_date	String	The date in "YYYY-MM-DD" when the user's account will expire. After this date, the user will not be able to login to ProcessMaker. Ex: "2020-12-31"
usr_status	String	The user's status, which can be "ACTIVE", "INACTIVE" or "VACATION".
usr_role	String	The user's role, which can be "PROCESSMAKER_ADMIN", "PROCESSMAKER_OPERATOR", "PROCESSMAKER_MANAGER" or a custom role.
usr_new_pass	String	The user's password. Remember that passwords should adhere to the password security policies.
usr_cnf_pass	String	Enter the password a second time to confirm it.
usr_address	String	Optional. The user's address. Use \n to include line breaks in the address. Ex: "345 Radcliff Drive\nC/O Brad Williams"
usr_zip_code	String	Optional. User's zip or postal code.
usr_country	String	Optional. Two letter ISO country code. See the wf_<WORKSPACE>.ISO_COUNTRY table in the database.
usr_city	String	Optional. One or two letter code to identify the region, state or province. Note: This field is misnamed. See the wf_<WORKSPACE>.ISO_SUBDIVISION table in the database.
usr_location	String	Optional. Code which is 1 to 3 letters long to identify the city or locality. See the wf_<WORKSPACE>.ISO_LOCATION table in the database.
usr_phone	String	Optional. The user's telephone number.
usr_position	String	Optional. The user's position in the organization.
usr_replaced_by	String	Optional. Unique ID of another user who will replace this user if his/her status changes to "INACTIVE" or "VACATION".
usr_calendar	String	Optional. The unique ID of the calendar which is used to calculate the due dates of tasks which the user is assigned to work on. To get the UID of a calendar, see the wf_<WORKSPACE>.CALENDAR_DEFINITION.CALENDAR_UID field in the database.
usr_time_zone	string	Optional parameter that is only available in the Enterprise Edition. The time zone of the user. Use one of the PHP time zones, such as "America/Mexico_City" or "Asia/Shanghai". In the US, use these time zones: US standard time zone PHP time zone Eastern America/New_York Central America/Chicago Mountain America/Denver Mountain no DST America/Phoenix Pacific America/Los_Angeles Alaska America/Anchorage Hawaii America/Adak Hawaii no DST Pacific/Honolulu

Result:

If a user was successfully created, the HTTP status code will be set to 200 and a JSON object with information about the new user is returned:

If an error occurred, the HTTP status code will be set to 400 or greater and a JSON object will be returned like the following:

PHP Example:

Upload User Image: POST /user/{usr_uid}/image-upload

Upload an image of the specified user, which will appear in the user's profile screen.

Permission:

The logged-in user needs to have the PM_USERS permission in his/her role in order to be able to perform this action.

Structure:

POST /api/1.0/{workspace}/user/{usr_uid}/image-upload

URL Parameters:

Name	Type	Description
workspace	String	Workspace name
usr_uid	String	User UID

POST Parameters:

Name	Type	Description	Examples
USR_PHOTO	string	The full path on the ProcessMaker server where the image file is located. The image file must be JPEG, PNG or GIF format. Note: If using PHP, make sure to place @ in front of the path to suppress error messages. Otherwise, this endpoint will not work.	"/home/bob/images/myphoto.jpg" "C:\Users\bob\images\myphoto.gif"

Result:
Returns an HTTP status code of 200 if the image was uploaded correctly. Otherwise, returns 0.

PHP Example:

If needing to upload image files which are not located on the ProcessMaker server, first use ssh2_scp_send() to copy the files to the ProcessMaker server, then use the code above to call the /api/1.0/{workspace}/user/{usr_uid}/image-upload endpoint.

Update User Information: PUT /user/{usr_uid}

Update the information about a specified user.

Permission:

The logged-in user needs to have the PM_USERS permission in his/her role in order to be able to perform this action.

Structure:

PUT /api/1.0/{workspace}/user/{usr_uid}

URL Parameters:

Name	Type	Description
workspace	String	Workspace name
usr_uid	String	User UID

PUT Parameters:

Only set the fields which need to be updated. PUT parameters need to be URL-encoded. In PHP, place the parameters in an associative array and use http_build_query() to encode it. In JavaScript, place the parameters in an object and then use encodeURIComponent() to encode it.

Name	Type	Description
usr_username	String	Optional. Username which is used to login to ProcessMaker and is unique.
usr_firstname	String	Optional. User's first name
usr_lastname	String	Optional. User's last name
usr_email	String	Optional. User's email address
usr_due_date	String	Optional. The date in "YYYY-MM-DD" when the user's account will expire. After this date, the user will not be able to login to ProcessMaker. Ex: "2020-12-31"
usr_status	String	Optional. The user's status, which can be "ACTIVE", "INACTIVE" or "VACATION".
usr_role	String	Optional. The user's role, which can be "PROCESSMAKER_ADMIN", "PROCESSMAKER_OPERATOR", "PROCESSMAKER_MANAGER" or a custom role.
usr_address	String	Optional. The user's address. Use \n to include line breaks in the address. Ex: "345 Radcliff Drive\nC/O Brad Williams"
usr_zip_code	String	Optional. User's zip or postal code.
usr_country	String	Optional. Two letter ISO country code. See the wf_<WORKSPACE>.ISO_COUNTRY table in the database.
usr_city	String	Optional. One or two letter code to identify the region, state or province. Note: This field is misnamed. See the wf_<WORKSPACE>.ISO_SUBDIVISION table in the database.
usr_location	String	Optional. Code which is 1 to 3 letters long to identify the city or locality. See the wf_<WORKSPACE>.ISO_LOCATION table in the database.
usr_phone	String	Optional. The user's telephone number.
usr_cellular	String	Optional. The user's cellular phone number.
usr_fax	String	Optional. The user's fax number.
usr_position	String	Optional. The user's position in the organization.
usr_birthday	String	Optional. The user's birthday in "YYYY-MM-DD" format. Ex: "1984-08-23"
usr_replaced_by	String	Optional. Unique ID of another user who will replace this user if his/her status changes to "INACTIVE" or "VACATION".
usr_new_pass	String	Optional. The user's password. Remember that passwords should adhere to the password security policies.
usr_cnf_pass	String	Optional. Enter the password a second time to confirm it. If this password doesn't match the one in usr_new_pass, then an error will occur.

Result:

If the user account was updated, the HTTP status code is set to 200 and it returns the following object with the updated information about the user:

If an error occurred, the HTTP status code is set to 400 and an error object like the following is returned:

PHP Example:
The following example, changes the status to "VACATION" and sets the user who will replace this user when she goes on vacation.

Note that the following line sets the request to be a PUT request:

Also note that the POST parameters need to be passed to http_build_query() to generate a URL-encoded query string which can be used with PUT requests.

Delete User: DELETE /user/{usr_uid}

Delete a specified user. This endpoint sets the wf_<WORKSPACE>.USERS.USR_USERNAME field to "" (empty string) in the database, so that the user can no longer be used, but it does NOT delete the user's record from the database.

Permission:

The logged-in user needs to have the PM_USERS permission in his/her role in order to be able to perform this action.

Structure:

DELETE /api/1.0/{workspace}/user/{usr_uid}

URL Parameters:

Name	Type	Description
workspace	String	Workspace name
usr_uid	String	User UID

Result:

If the user was successfully deleted, then the HTTP response code will be 200. If an error occurs, then the HTTP response code is set to 400 and an object like the following is returned:

PHP Example: