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.

Method

GET /tenant

Name	Description
id	Filter by the id of the tenant.
name	Filter by the name of the tenant.
nameLike	Filter by the name that the parameter is a substring of.
userMember	Select only tenants where the given user is a member of.
groupMember	Select only tenants where the given group is a member of.
includingGroupsOfUser	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.
sortBy	Sort the results lexicographically by a given criterion. Valid values are `id` and `name`. Must be used in conjunction with the `sortOrder` parameter.
sortOrder	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.
firstResult	Pagination of results. Specifies the index of the first result to return.
maxResults	Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

A JSON array of tenant objects. Each tenant object has the following properties:

Name	Value	Description
id	String	The id of the tenant.
name	String	The name of the tenant.

Code	Media type	Description
200	application/json	Request successful.
400	application/json	Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy` is specified. See the Introduction for the error response format.

GET /tenant?name=tenantOne

Status 200.

[{
  "id":"tenantOne",
  "name":"Tenant One"
}]