Skip to main content
GET
/
user
Get List
curl --request GET \
  --url http://{host}:{port}/{contextPath}/user \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "jonny1",
    "firstName": "John",
    "lastName": "Doe",
    "email": "anEmailAddress"
  },
  {
    "id": "jonny2",
    "firstName": "John",
    "lastName": "Smoe",
    "email": "anotherEmailAddress"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
id
string

Filter by user id

​
idIn
string

Filter by a comma-separated list of user ids.

​
firstName
string

Filter by the first name of the user. Exact match.

​
firstNameLike
string

Filter by the first name that the parameter is a substring of.

​
lastName
string

Filter by the last name of the user. Exact match.

​
lastNameLike
string

Filter by the last name that the parameter is a substring of.

​
email
string

Filter by the email of the user. Exact match.

​
emailLike
string

Filter by the email that the parameter is a substring of.

​
memberOfGroup
string

Filter for users which are members of the given group.

​
memberOfTenant
string

Filter for users which are members of the given tenant.

​
potentialStarter
string

Only select Users that are potential starter for the given process definition.

​
sortBy
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
userId,
firstName,
lastName,
email
​
sortOrder
enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:
asc,
desc
​
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

​
maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

​
id
string | null

The id of the user.

​
firstName
string | null

The first name of the user.

​
lastName
string | null

The first name of the user.

​
email
string | null

The email of the user.