Queries tenants, scoped to an application, based on a query expression.

Query Filter Attributes

Name	Type	Case Sensitive	Supported Comparison Operators
`id`	String	Yes	eq, ne, in, nin
`type`	String	No	eq, ne, in, nin
`domainName`	String	No	eq, ne, sw, lt, le, gt, ge, in, nin
`name`	String	No	eq, ne, sw, lt, le, gt, ge, in, nin
`displayName`	String	No	eq, ne, sw, lt, le, gt, ge, in, nin
`discoveryEmailDomains`	String	No	eq, ne, sw, lt, le, gt, ge, in, nin
`status`	String	No	eq, ne, in, nin

Sort Attributes

id
type
domainName
name
displayName
status

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

Permission	Boundary	Description
tenant:read	Application	The subject can query the tenants associated with the application to which the subject belongs.

Permissions Required To Include Associated Application

In addition to the permissions above, the following permissions are required if the tenant's associated application is specified to be returned in the response by including a non-empty value for the application_fields query parameter.

Permission	Condition	Boundary	Description
application:read	Required if the `application_fields` query param is not empty	Application	The subject can read the application associated with each tenant.