Configuration: Identity v3 (Powered by Auth0)
Prerequisite Tasks
The following tasks must be completed before Aspenware can install the Identity v3 (Powered by Auth0) plugin. Please contact Aspenware Customer Success (support@aspenware.com) if you have any questions.
Hosting and Minimum Versions
To implement Identity v3 (Powered by Auth0), your resort must meet the following criteria:
Resort must be an Aspenware Cloud customer using the Aspenware Cloud hosting platform.
Resort must be on the following minimum versions or later:
Unity 3.47
Commerce 3.6
Accounts 1.8.1
Cloud UI 1.7
Arrival 1.10
Resort must have an active account with Auth0.
Auth0 Tasks
Please provide the following selections or information to Aspenware for configuration of your Identity v3 (Powered by Auth0) platform.
Description | Customer Value | |
What Resort is this tenant for? This will be used as the Resort “friendly name” that is in emails | Input your resort name: |
|
What sub-domain would you like to use? (If it’s the same as the current one, please list regardless). Example {domain}.ResortName.com YOU MUST CHOOSE A NEW SUB-DOMAIN NAME. We recommend ‘auth’ or ‘login.' | Please input the sub-domain for login and create account flows: |
|
Age Restriction (Will default to 13) | Please input the minimum age to create account: |
|
Password Strength * This is enforced for new account creation. Existing accounts will continue to work with previous password strength. | Please input your selection for password strength: |
|
Auth0 transactional emails include: Forgot passwords, customer verifications, and invitations.
*Commerce emails like order confirmations can still be sent via Inntopia or any other email provider you have. | SMTP Provider: |
|
From Email Address (used to send reset passwords, verifications, etc): |
| |
Tenant ID (MS365 only): |
| |
Client ID/Active Directory (MS365 only): |
| |
Client Secret/Active Directory (MS365 Only): |
| |
(SMTP) Host Name: |
| |
(SMTP) Port: |
| |
(SMTP) Username: |
| |
(SMTP) Password: |
| |
(SMTP) API Key: |
| |
For guests who need to troubleshoot account issues, please list a phone number (Customer Matching, etc.) for guests to call. | Phone: |
|
Tenant Support email: Can be used as a ‘variable’ in an email that is sent to guests from auth0 (password reset, verifications, etc.) | Email: |
|
Google Tag Manager ID (Login & Create Account Metrics). | GTM ID: |
|
Add marketing consent to create customer? | Input Yes or No: |
|
Account Lookup with Pass? | Input Yes or No: |
|
Create Account with Pass? | Input Yes or No: |
|
Do you have RTP Rewards Module? | Input Yes or No: |
|
Is this resort part of a multi-store environment? If so, please list all the resorts associated. | Input Yes or No: |
|
Please list your store URLs here: | ||
Do you have Aspenware Arrival? | Input Yes or No: |
|
Do you have 3rd party applications? If yes, fill out page 2 | Input Yes or No: |
|
3rd Party Applications
Resort completes the application section on the onboarding form below and sends to Aspenware.
Application Description
Application type
Callback URL
Logout URL
withScheme (recommended 'app')
Aspenware sets up Auth0 applications for the Resort 3rd party application.
Once application(s) are setup in Auth0 Tenant, Aspenware will provide resort with connection name and scope to put in their application(s) code-base.
Resort Dev team to setup application using Auth0 guidelines.
Resort Dev team to test.
Aspenware Dev to guide/assist during process.
Applications | |
|
|
1a. Android/iOS/Other |
|
1b. Callback URL |
|
1c. Logout URL |
|
1d. withScheme (We recommend ‘app’) |
|
Theming Tasks
If the resort is already on Identity, Aspenware can use the theming elements already provided. For a new implementation, please provide the following:
Theme Options | Customer Values | |
Resort Logo | Attach logo (logo scales) in email: |
|
Background Image or Color | Attach Image (1920x1080) or provide Color HEX: |
|
Favicon Image | Attach Favicon: |
|
Brand Font | Provide URL to Brand Font: |
|
Button Color | Provide Color Hex: |
|
Text Color | Provide Color Hex: |
|
Link Color | Provide Color Hex: |
|
Mask (overlay) Color | Provide Color Hex: |
|
Content & Language Strings
Auth0 Sign-in Screens | ||
Description | Language String | Default |
Title | title | None |
Description | description | None |
Email placeholder | emailPlaceolder | |
Account lookup link | var-passMediaLinkText | Lookup email by pass number |
Account lookup title | var-passMediaTitleText | Let’s lookup your account |
Lookup instruction | var-passMediaInstructionsText | Enter the number on your pass |
Pass number | passMediaFieldLabel | Pass Number |
Account lookup Success message | var-passMediaSuccessPrompt | An Account was found |
Account lookup success body | var-passMediaSuccessDescription | The email we have on file with this pass number is: |
Auth0 Sign-Up Screens | ||
Description | Language String | Default |
Title | title | None |
Description | description | None |
Email placeholder | emailPlaceolder | |
Yes/No for Pass | var-havePassTitle | Do you have a pass |
Instruction | var-passNumberTitle | Enter the number on your pass |
‘Pass number’ field placeholder | var-passMediaFieldLabel | Pass number |
Create account with pass error: | var-signupWithPassError | There was a problem creating your account. Please call resort ###-###-#### or create an account without a pass |
Receive updates and what’s new happening at {resort} | accounts.userprofile.receiveemailstext | Receive updates and what’s new happening at {resort} |
Customer matching | accounts.accountexists.subtitle | Call Resort to verify account Resort phone number: ###-###-#### |
Rewards Enrollment Consent | Accounts.UserProfile.CustomConsentDescription | This is a custom consent message with a link |
Create Customer Profile Page
Description | Language String | Default |
---|---|---|
Create Customer | accounts.userprofile.detailsheading | Account details |
Create Customer | accounts.userprofile.formtitle.existinguser | Can you help us with a few required details? |
Create Customer | accounts.userprofile.formtitle.newuser | Almost there! Finishing setting u your account |
Create Customer (Rewards) | accounts.userprofile. customconsentdescription | This is a custom consent message with a [link](https://example.com |
Create Customer (marketing) | accounts.userprofile.receiveemailstext | Receive updates and what's new happening at [TODO] |
Create Customer | accounts.userprofile.updateprofileerror | There was an error updating your profile. Please try again |
Single Customer Verification | accounts.verificationrequired.subtitle | Verify your identity |
Single Customer Verification | accounts.verificationrequired.title | Account already exists |
Single Customer Verification | accounts.verificationrequired.verificationsent | Verification sent via email |
Multiple Customer Match | accounts.accountexists.contactlabel | Resort phone number |
Multiple Customer Match | accounts.accountexists.contactnumber | (###)-###-#### |
Multiple Customer Match | accounts.accountexists.subtitle | Call resort to verify account |
Multiple Customer Match | accounts.accountexists.title | Account already exists |
Customer profile (if rewards enrollment enabled) | Accounts.UserProfile.CustomConsentDescription | This is a custom consent message with a link |
Required information - new user | accounts.userprofile.formtitle.newuser | Almost there! Finish setting up your account. |
Required information - existing user | accounts.userprofile.formtitle.existinguser | Can you help us with a few required details? |
Aspenware Commerce Tasks
NOTE: Credentials will continue to be stored in RTP; Resort support staff can still adjust auth profile credentials.
Settings
Configuration | Description |
---|---|
customersettings.usernamesenabled | Must set to FALSE to disable usernames in Aspenware Commerce. |
customersettings.dateofbirthminimumage | Ability to set the age restriction for creating an account |
ordersettings.anonymouscheckoutbyproduct | Enables guest checkout to occur. |
checkout.guestcheckout.preferguest | Must be set to ‘true.' Enables guest to sign in as an option. |
auth0externalauthsettings.emailmarketingconsentenabled | Enable Email Marketing on create customer |
auth0externalauthsettings.customconsentenabled | Enables custom consent to be submitted by guest when completing customer profile (E.g. rewards enrollment) |
auth0externalauthsettings.customconsentdefaultvalue | Defaults consent checkbox to checked or unchecked |
Reporting via Google Analytics
Identify v3 (Powered by Auth0) includes robust Google Analytics tracking. The following events are included in the data layer.
Location | Event Name | Project | Schema / Message | Use Case |
Login | successful_login | Commerce |
| User has signed in successfully and landed on store |
Login | error | Auth0 | errorType: "signin_error," "errorMessage": "{message}" | User has encountered an error, password or API |
Sign-in Page | n/a | Auth0 |
| When a customer views sign in page |
Forgot password page | n/a | Auth0 |
| Customer view ‘forgot password’ page |
Forgot Password | forgot_password_submitted | Auth0 |
| User has sent a password reset email |
Sign up | signup_selection | Auth0 |
| User has selected 'sign up' |
Sign up | signup_success | Auth0 |
| User has created an account in auth0 (email/password) |
Sign up | create_profile | Commerce |
| User has created a customer |
Sign up | successful_login | Commerce |
| User has been authenticated and logged in successfully and landed on store |
Sign up | error | Auth0 | errorType: "auth0_signup_error," "errorMessage": "{message}" | User has encountered an error, user exists or API |
Customer profile page | n/a | AW Cloud UI |
| Customer views create customer profile page |
Customer Matching | signup_success | Auth0 |
| User has created an account in auth0 (email/password) |
Customer Matching | create_profile | Commerce |
| User has created a customer |
Customer Matching | customer_match | Commerce | { "event": "awc_customer_match", "type", "#"} | User has matched to a customer in RTP |
Customer match (1) page | n/a | AW Cloud UI |
| Customer views ‘verification needed’ page after match |
Customer match (many) page | n/a | AW Cloud UI |
| Customer view ‘call resort’ after being matched to multiple customers in RTP |
Account Lookup | account_lookup | Auth0 |
| User has selected 'account lookup with pass number' on sign in screen |
Account Lookup | account_found | Auth0 |
| User entered a pass that is associated with an account |
Account Lookup | account_notfound | Auth0 | { "event": "error", "errorType": "account not found", "errorMessage": "{error message}" } | User entered a pass that is not associated with an account |
Pass Account Create | signup | Auth0 | signupMethod: "pass_media" | User has entered a valid pass number |
Pass Account Create | verify_account_view | Auth0 | signupMethod: "pass_media" | User has been sent an email to verify their identity before finishing account create with pass flow |
Pass Account Create | resend_email | Auth0 | signupMethod: "pass_media" | User has resent invite |
Pass Account Create | signup_error | Auth0 | signupMethod: "pass_media", "message": "no_email" | User has encountered an error related to customer not having an email profile on file in RTP |
Pass Account Create | signup_error | Auth0 | signupMethod: "pass_media", "message": "account_exists" | User has encountered an error related to customer having an existing account |
Pass Account Create | signup_error | Auth0 | signupMethod: "pass_media", "message": "invalid_value" | User has encountered an error related to a wrongly input pass number |
Pass Account Create | create_profile | Commerce |
| User has accepted invite, added a password, and has completed their profile |
Pass Account Create | successful_login | Commerce |
| User has accepted invite, added a password, and has completed their profile, and signed in/landed on store |
Add password | n/a | Auth0 | Page View | When a guest lands on the add password screen |
Implementation
Once Aspenware has received your onboarding information, they will send you a timeline for your implementation and be in contact as the process progresses.
Questions about Identity v3 (Powered by Auth)? Check out our Frequently Asked Questions page or contact your Aspenware Customer Success Representative.