post https://{applicationQualifiedDomain}.us.wristband.dev/api/v1/tenant-discovery/fetch-tenants
Fetches all distinct tenants that a user is associated to within an application that satisfy the following criteria:
- The tenant much contain a user whose email matches the specified email in the tenant discovery request.
- The user's email must be be verified.
- The user must have an
ACTIVE
status - The tenant must have an
ACTIVE
status.
Note, this API can be called in two distinct ways.
- The first way is directly. With this approach the
applicationId
andemail
fields must be provided in the request body. Optionally, aclientId
can be provided to utilize the login URL from the client when resolving the login URLs returned in the response. - The second way is from an email tenant discovery flow. With this approach the
emailAuthCode
field must be provided in the request body. The results returned in the response will be based off theapplicationId
andemail
fields that were specified when the tenant discovery email was sent.
This API utilizes cursor pagination with the results being sorted by tenantDomainName
in ascending order.
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-discovery-workflow:execute | Application | The subject can perform this operation for requests associated to the application that the subject belongs to. |