Fetch Tenants

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
1 to 50
Defaults to 20

The maximum number of results that can be returned in a query response.

string

Cursor that will be used to retrieve the previous page of results. Note, the page_before and page_after query parameters can't both be used in the same request.

string

Cursor that will be used to retrieve the next page of results. Note, the page_before and page_after query parameters can't both be used in the same request.

boolean
Defaults to false

If this value is set to true, then active tenants that have a discovery email domain equal to the domain of the email specified in the discovery request will be returned in the results.

Body Params

Fetch Tenants Request JSON object

string
length ≥ 1

The email auth code that will be used to authorize the request. If provided then all other request fields must be null.

string
length between 1 and 26

The ID of the application that the fetch tenants request will be scoped to, only tenants belonging to this application will be returned. If provided then all other request fields must be null except for email and clientId.

string
length between 1 and 200

The email of the user whose tenants should be retrieved. Tenants that have an active user with a verified email matching this email will be returned in the results. If provided then all other request fields must be null except for applicationId and clientId.

string
length between 1 and 26

Optional ID of the client that initiated the request. If the client has a login URL defined it will be used to resolve the login URL returned in the response instead of the application login URL. If provided then all other request fields must be null except for applicationId and email.

string
length ≥ 1

A code that is used to identify the current tenant discovery request. If provided then all other request fields must be null except for verificationCode.

string
length ≥ 1

The verification code that was sent to the user's email. If provided then all other request fields must be null except for requestCode.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json