Signup: Self-Hosted UI
Wristband Identity Provider Signup
If you intend to self-host any of the Signup Pages and utilize Wristband APIs to facilitate the Signup Workflow, it is necessary to override the Custom Signup Page URLs in the Wristband Dashboard for your application. This ensures that Wristband directs users to the specified locations whenever your self-hosted Signup Page needs to be presented. Some examples of where Wristband references the Custom Signup Page URLs:
- Signup Action Links at the bottom of Wristband-hosted Login Page Forms
- External IDP Signup Workflow when displaying the External IDP Signup Form after authenticating with your external identity provider
User Activation Signup
At a high level:
- The user clicks on the Signup button either on your website or within your application.
- The user gets sent to your application's self-hosted Signup Page.
- The user provides all information to the Signup Form and clicks the submit button.
- Your application calls the Provision User API to complete the Signup for the user.
- An Activation Email is sent to the email address that the user provided on the Signup Form.
From here, the user would then complete the User Activation Workflow to finish activating themselves, verify their email, and gain entry into the application. It is up to your application what to display to the end user at this point of the workflow.
Email Verification Signup
- The user clicks on the Signup button either on your website or within your application.
- The user gets sent to your application's self-hosted Signup Page.
- The user provides all information to the Signup Form and clicks the submit button.
- Your application calls the Provision User API to complete the Signup for the user. During API execution, an Email Verification email is sent to the email address that the user provided on the Signup Form. The user is also set to
ACTIVE
status. - Your application then redirects the user to the Wristband Create Auth Session API in order to create a Wristband Authentication Session for the user. The redirect URL is returned in the response from the prior step as well as an Auth Session Code that is required to successfully create the session.
- Wristband redirects the user to the Login Endpoint implemented by your application.
From here, the user would be sent through the Authorization Code Flow in order to login and gain entry to the application. Because Wristband already created an Authentication Session for the user during signup, the user gains immediate entry into the application without having to re-enter their credentials. However, they will still need to separately complete the Email Verification Workflow in order to have their email verified.
External Identity Provider Signup
At a high level:
- The user clicks on the Signup button either on your website or within your application.
- The user gets sent to your application's self-hosted Signup Page.
- The user clicks on a "Signup With Google" button.
- Your application redirects the user to Google's Authorization Endpoint where they will enter their Google login credentials.
- Google redirects the user back to the Wristband External IDP Callback Endpoint (exact URL is located in the Wristband Dashboard for the corresponding external identity provider).
- Wristband redirects the user to your application's Custom External IDP Signup Page URL (configured in the Wristband dashboard) along with an External IDP Authorization Code that will be used for creating an Authentication Session.
- Prior to rendering your application's self-hosted External IDP Signup Page, your application will call the Wristband Fetch External IDP Userinfo API, passing along the External IDP Authorization Code. This is necessary for syncing the external IDP userinfo into Wristband during Signup.
- Your application now renders the self-hosted External IDP Signup Page along with an External IDP Authorization Code that will be used for creating an Authentication Session.
- The user provides all information to the External IDP Signup Form and clicks the submit button.
- Your application calls the Provision External IDP User API, passing along the External IDP Authorization Code.
- Your application then redirects the user to the Wristband Create Auth Session for External IDP User API in order to create a Wristband Authentication Session for the user. The redirect URL is returned in the response from the prior step as well as an Auth Session Code that is required to successfully create the session.
- Wristband redirects the user to the Login Endpoint implemented by your application.
From here, the user would be sent through the Authorization Code Flow in order to login and gain entry to the application. Because Wristband already created an Authentication Session for the user during signup, the user gains immediate entry into the application without having to re-enter their credentials.
Unverified Emails from External Identity ProvidersIf the email address synchronized from the external identity provider is not verified, the user must undergo either the User Activation Workflow or the Email Verification Workflow to complete External IDP Signup, depending on the configured Signup Workflow Policy.
Updated 4 months ago