Sign in
Tenant

Get Tenants

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

get/tenant

Request

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

Query parameters

sortBy'id' | 'name'

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.

idstring

Filter by the id of the tenant.

namestring

Filter by the name of the tenant.

nameLikestring

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

userMemberstring

Select only tenants where the given user is a member of.

groupMemberstring

Select only tenants where the given group is a member of.

includingGroupsOfUserboolean

Select only tenants where the user or one of his groups is a member of. Can only be used in combination with the userMember parameter. Value may only be true, as false is the default behavior.

Response

Request successful.

idstring nullable

The id of the tenant.

namestring nullable

The name of the tenant.

Changes

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