Skip to main content
GET
/
tenant
Get Tenants
curl --request GET \
  --url http://{host}:{port}/{contextPath}/tenant \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "tenantOne",
    "name": "Tenant One"
  }
]

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

​
sortBy
enum<string>

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

Available options:
id,
name
​
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.

​
id
string

Filter by the id of the tenant.

​
name
string

Filter by the name of the tenant.

​
nameLike
string

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

​
userMember
string

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

​
groupMember
string

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

​
includingGroupsOfUser
boolean

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.

​
id
string | null

The id of the tenant.

​
name
string | null

The name of the tenant.