Query Application Tenants

get

https://{application_vanity_domain}/api/v1/applications/{applicationId}/tenants

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

Path Params

applicationId

string

required

length between 1 and 26

The ID of the application that the resource or action is scoped to.

Query Params

query

string

length ≥ 0

Defaults to ""

Query expression used to filter returned results in a query API call.

sort_by

string

List of attributes that the results of a query should be sorted by along with their corresponding sort orders. The items that occur earlier in the list will have higher sorting precedence than those that occur later in the list.

start_index

number

≥ 1

Defaults to 1

A 1-based index indicating the position of the first item that should be returned in the query response.

count

number

≥ 0

Defaults to 20

The maximum number of results that can be returned in a query response. If the value is set to 0 then the items array in the response will be empty; however the total results will still be set so you can see how many items this query matched.

fields

string

length ≥ 0

Defaults to *

List of resource fields that should be returned in a response. The wildcard value of * can be used to return all fields for the resource.

application_fields

string

length ≥ 0

Defaults to *

List of application fields that should be returned in a response for which the given tenant belongs to. This allows for convenience of fetching both tenant and application data in the same request. The wildcard value of "*" can be used to return all fields for the application.

Responses

Query Filter Attributes

Sort Attributes

Required Permissions

Permissions Required To Include Associated Application

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

406Not Acceptable

500Internal Server Error

503Service Unavailable