Find User Tenant

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Attempts to find the user's tenant based on the specified application and email. This API will search for the user's tenants using the following criteria:

  1. A user must exist in the tenant with an ACTIVE status and a verified email matching the email from the tenant discovery request. Or, the domain of the email from the request must match one of the tenant's discovery email domains.
  2. The tenant must have an ACTIVE status.
  3. The tenant can't be of type GLOBAL.

Depending on the number of tenants found for the given email and application, one of the following operations will be performed.

  1. If no tenants are found, then a 404 response is returned with a tenant_not_found error code.
  2. If exactly one tenant is found, then this API will return a TENANT_FOUND result with a redirect URL pointing towards the tenant's login URL.
  3. If more than one tenant is found, this API will send a tenant discovery email containing either a verification link or a verification code to the specified email address, allowing the user to view the tenants they belong to.

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.

PermissionBoundaryDescription
tenant-discovery-workflow:executeApplicationThe subject can perform this operation for requests associated with the application to which the subject belongs.
Body Params

Find User Tenant Request JSON object

Request to find a user's tenant.

string
required
length between 1 and 26

ID of the application that the tenant is associated to.

string
required
length between 1 and 200

The email address that will be used to look up the application's users.

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 take precedence over the application login URL.

string
length between 1 and 26

Optional string that can be used to transfer state across the tenant discovery request. If provided, the value will be appended as a state query parameter to the discovered tenant login URLs.

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