Site Home
API Reference
LoginTry for Free

Resolve Tenant Login URL

post
https://{application_vanity_domain}/api/v1/tenant-discovery/resolve-login-url
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Resolves the login URL for the specified tenant, identified by the application and tenant name.

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

Request Tenants Request JSON object

Request to resolve a tenant's login URL.

string
required
length between 1 and 26

ID of the application that the tenant is associated to.

string
length between 1 and 20
deprecated

Deprecation Notice: This field has been replaced by the tenantName field and should no longer be used. In the future, this field may be removed.

The name of the tenant whose login URL will be resolved.

string
required
length between 1 and 20

The name of the tenant whose login URL will be resolved.

string
length between 1 and 26

Optional ID of the client that initiated the resolve login URL request. If the client has a login URL defined it will take precedence over the application login URL.

string
length between 1 and 26

If provided, the value will be appended as a state query parameter to the resolved tenant login URL.

Responses

Updated 25 days ago

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

Updated 25 days ago