Sign in
User

Get List

Query for a list of users using a list of parameters. The size of the result set can be retrieved by using the Get User Count method. Get User Count method.

get/user

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/user
  • Auth: HTTP basic

Query parameters

idstring

Filter by user id

idInstring

Filter by a comma-separated list of user ids.

firstNamestring

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

firstNameLikestring

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

lastNamestring

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

lastNameLikestring

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

emailstring

Filter by the email of the user. Exact match.

emailLikestring

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

memberOfGroupstring

Filter for users which are members of the given group.

memberOfTenantstring

Filter for users which are members of the given tenant.

potentialStarterstring

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

sortBy'userId' | 'firstName' | 'lastName' | 'email'

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

sortOrder'asc' | 'desc'

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.

firstResultinteger

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

maxResultsinteger

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.

idstring nullable

The id of the user.

firstNamestring nullable

The first name of the user.

lastNamestring nullable

The first name of the user.

emailstring nullable

The email of the user.

Changes

No recorded changes to this operation across all 1 revision of this API.