Login Workflow
Login URLs for Wristband-hosted Pages
There are publicly available URLs where you can reach the Wristband-hosted Login Pages for both the Application level and the Tenant level (if multi-tenant).
Wristband Vanity Domains
Let's say we have a Wristband application named "Your App" with the application domain name yourapp
. For a multi-tenant application with a tenant named "Your Customer" and the domain yourcustomer
, the URLs would be as follows:
Login Type | URL |
---|---|
Application Level | https://yourapp-yourcompany.us.wristband.dev/login |
Tenant Level | https://yourcustomer-yourapp-yourcompany.us.wristband.dev/login |
Custom Domains
For a custom domain auth.yourapp.io
, the URLs would be:
Login Type | URL |
---|---|
Application Level | https://auth.yourapp.io/login |
Tenant Level | https://yourcustomer.auth.yourapp.io/login |
Supported Query Parameters
The URLs for the Wristband-hosted Login pages can support certain query parameters:
Query Parameter | Required | Supported Login Pages | Description |
---|---|---|---|
req | Yes | Tenant-level Login | The authorization request JWT used by the Login Page to infer your application's original authorization request parameters. The request parameters must have initially been passed as query parameters when redirecting from your application's Login Endpoint to the Wristband Authorize Endpoint. |
client_id | No | Application-level Login | Specifies the clientId associated with the desired OAuth2 Client whose login URL you intend to utilize. Include this query parameter when navigating to the Application-level Login Page to ensure continuity. |
Signup Links on Login Forms
Signup Action Links are available at the bottom of the Login Form on certain Wristband-hosted Login Pages (if Signup is enabled).
Application-level Signup Action Link
Tenant-level Signup Action Link
The expected mapping of Login Pages to Signup Action Link locations:
Login Page | Signup Location |
---|---|
Application-level Login | Application-level Signup |
Tenant-level Login | Tenant-level Signup |
Application-Level vs Tenant-Level Login
In Wristband, users can interact with two phases of the login process.
Application-Level Login
Users can access the Application-level Login page for Tenant Discovery. This page directs the user to the specific Tenant-level login page they wish to access, akin to using a directory in a mall to find a specific store.
Learn more on the Tenant Discovery documentation page.
Tenant-Level Login
The Tenant-level Login Page is the second and final login page a user interacts with during authentication. Users typically perform tenant discovery on the Application-level Login page to reach the Tenant-level Login Page. It is also possible to bookmark the URL of the Tenant-level Login Page to bypass Application-level Login. When accessing this page, your application's Login Endpoint must redirect to the Wristband Authorize Endpoint to start an authorization request. This page can be accessed directly and bookmarked if the URL is known in advance.
Updated 5 months ago