| Table of Contents |
|---|
...
Find and install the Identity Plugin
In the Aspenware Commerce admin panel go to Configuration > Local Plugins
Search the list for ExternalAuth Methods : Identity Authentication
Select Install.
Once installation is complete, select Restart application to apply changes at the top of the page.
| Info |
|---|
NOTE: This restart can take up to 7 minutes to complete and should occur during low-traffic times. |
Configure Identity External Authentication
Go to Configuration > External Authentication
If the Identity plugin has been successfully installed you will see it on the admin screen.
Select Configure.
Enter your OpenID, ClientID, and OpenID ClientSecret (these are created and provided by Aspenware).
In the Authority to use when connecting to OpenID field enter the web address (URL) that will be using Identity.
Select Save.
Return to the External Authentication Admin page and select Edit.
Select the check box under the Is active column then select Update.
Identity Tasks
Settings and Language Strings
...
Setting | Values | Description |
|---|---|---|
| True/False | If an account is found, if TRUE, guest will be texted or emailed a code to verify that they are allowed to claim the account, if FALSE, the guest will be able to create an authentication profile on a found account with no verification required. |
| True/False | If TRUE, guest can login using their pass media or RFID number. If FALSE, login with pass number is disabled. If set to true, there are language strings that should be setup to reflect that this is allowed for guests as well. |
| 13 is the default | Age limit for guests to create accounts |
| True/False | When set to TRUE this setting will enforce a password reset for all users logging in through identity with an RTP password date change of today (automatically set in Azure) minus the “PasswordChangeDays” set below. If FALSE, guests will never be forced to reset their password. |
| 750 is the default | Only needed if |
NEED SETTING NAME for Terms and Conditions 1 check box appearing |
| This should only be enabled if Loyalty is configured for your store. This checkbox will only appear if a customer who is logging in does not already have a Boyne Rewards loyalty sign up. By clicking the box and accepting, the guest would enroll in the program. In subsequent logins, T&C 1 would not appear. |
NEED SETTING NAME for Terms and Conditions 1 check box default as checked/unchecked |
| This loyalty sign up checkbox can be set to be enabled by default or disabled by default. |
NEED SETTING NAME for Terms and Conditions 2 check box appearing |
| Can be used for generic terms and condition agreement. If enabled, this checkbox would appear on every login, and would not record the action taken by the guest. |
NEED SETTING NAME for Terms and Conditions 2 check box default as checked/unchecked |
| This Terms and Conditions sign up checkbox can be set to be enabled by default or disabled by default. |
...
Setting | Description | Specs |
|---|---|---|
| Web-based URL of logo - this setting determines determines what logo displays in the email. | |
| This setting determines what footer text displays in the email. | Typically used for address, phone number and/or contact email. |
| This setting determines what resort name displays in the email. | (i.e. Peak Resort) |
| This setting determines where the user is taken if they click the logo in the email. | (i.e. http://aspenware.com ) |
Language Strings
Most language strings within Identity are configurable. These language strings are updated using a JSON file and will be defined during the implementation process of Identity. Most language strings can retain default values, however, the following language strings are recommended for customization. View a full list of language strings.
Login Page Language Strings
...
Description
...
String Resource
...
Current Value
...
Placement
...
Login page
...
account.login.description
...
Please sign in or create an account.
...
Displays beneath page title, is a collapsed and invisible if no text is entered.
...
Login page
...
account.login.loginoptions
...
Email, Username, or Pass ID
...
Displays above line where user types in username, email, or pass ID
...
Login page
...
account.login.validation.invalid
...
Email, Username, or Pass ID is invalid.
...
Displays beneath username entry field when continue button is selected but no characters entered in username field
...
Login page
...
account.login.validation.callservices
...
We’ve encountered a problem logging you in. Please contact customer service at ###-###-####.
...
Displays beneath username entry field when email profile matches up with multiple authIDs
...
Login page
...
account.login.callservices.noemailprofile
...
Create Account/Claim Account Settings
Setting | Description | Specs |
|---|---|---|
RequireAccountVerification | This setting determines whether a guest will have to receive a verification code via phone or email in order to claim their account. | TRUE or FALSE |
CheckPassMediaForFindUser | This setting determines whether a guest can log or claim an account using their pass media #. | To allow guests to log in or find their account using pass media, set to TRUE, otherwise, set to FALSE. |
AgeLimit | This setting determines how old a user can be in order to create an account. |
Language Strings
Most language strings within Identity are configurable. These language strings are updated using a JSON file and will be defined during the implementation process of Identity. Most language strings can retain default values, however, the following language strings are recommended for customization. View a full list of language strings.
Login Page Language Strings
...
Force Password Reset (Only if setting PasswordExpirationEnabled is true) Language Strings
Description
String Resource
Current Value
Login → Force Reset Password
account.passwordexpired.passwordexpired
Password Expired
String Resource | Current Value | Placement |
account.login.description | Please sign in or create an account. | Displays beneath page title, is a collapsed and invisible if no text is entered. |
account.login.signin | Sign In | Displays on top of login page. |
account.login.loginoptions | Email, Username, or Pass ID | Displays above line where user types in username, email, or pass ID |
account.login.validation.invalid | Email, Username, or Pass ID is invalid. | Displays beneath username entry field when | user has a username that is not an email and has no email profile.
Reset Password Page Language Strings
...
Description
...
String Resource
...
Current Value
...
Placement
...
Login → Reset Password Page
...
account.forgotpassword.description
...
To reset your password, please enter your email or username and select continue."
...
Displays beneath title, if no description is entered area is collapsed.
...
Login → Reset Password Page
...
account.forgotpassword.username
...
Email or username
...
Displays beneath description above entry field.
...
Login → Reset Password Page
...
account.forgotpassword.validation.success
...
Success! An email and link for resetting your password has been sent to this address.
...
Displays beneath email.username field after password reset email is sent.
...
Login → Reset Password Page
...
account.forgotpassword.validation.invalid
...
Invalid email address, please try again.
...
Displays beneath email.username field if invalid entry.
Create Account Page Language Strings
...
Description
...
String Resource
...
Current Value
...
Placement
...
Create Account page
...
account.create.createaccount
...
Create an Account
...
Top of create account page
...
Create Account page
...
account.create.description
...
Already have an account?
...
Displays beneath page title. Text area is collapsed if no text is entered.
...
Create Account page
...
account.create.accountexists.signin
...
Sign in [URL]
...
active url after “Already have an account” text
...
Claim Account Language Strings
...
Description
...
String Resource
...
Current Value
...
Placement
...
Claim Account → Select Account page
...
account.claim.selectaccount
...
Select Account
...
Title displays at top page
...
Claim Account → Select Account page
...
account.claim.description
...
We found two or more accounts that match information you entered. Please select an account to continue.
...
Description displays beneath title. If no text is entered, this text box will collapse.
...
Claim Account → Select Account page
...
account.claim.select
...
Select Account
...
Displays beneath description and above selection dropdown.
...
Claim Account → Verify Account page
...
account.claim.verify.description
...
We found a matching account. Please select a delivery method for your verification code.
...
Description displays beneath title. If no text is entered, this text box will collapse.
...
Claim Account → Verify Account page
...
account.claim.select
...
Select Account
...
Displays beneath description and above selection dropdown.
continue button is selected but no characters entered in username field | ||
account.login.validation.callservices | We’ve encountered a problem logging you in. Please contact customer service at ###-###-####. | Displays beneath username entry field when email profile matches up with multiple authIDs |
account.login.callservices.noemailprofile | We’ve encountered a problem logging you in. Please contact customer service at ###-###-####. Error: Account has no email profile. | Displays beneath username entry field when user has a username that is not an email and has no email profile. |
account.login.newuser | New user? | Displays above login field and below Sign In. |
account.login.createaccount | Create an account [URL] | Follows “New user?” |
account.login.password.signin | Sign In |
|
account.login.password.description | Enter your password below. If you forget your password reset it by selecting 'Reset password' | Displays beneath page title, messaging is collapsed and invisible if no text is entered. |
account.login.password.password | Password | Displays beneath customer username and above password entry field. |
account.login.callservices.noemailprofile | We’ve encountered a problem logging you in. Please contact customer service at ###-###-####. Error: Account has no email profile. | Displays beneath username entry field when user has a username that is not an email and has no email profile. |
Reset Password Page Language Strings
...
String Resource | Current Value | Placement |
account.forgotpassword.description | To reset your password, please enter your email or username and select continue." | Displays beneath title, if no description is entered area is collapsed. |
account.forgotpassword.username | Email or username | Displays beneath description above entry field. |
account.forgotpassword.validation.success | Success! An email and link for resetting your password has been sent to this address. | Displays beneath email.username field after password reset email is sent. |
account.forgotpassword.validation.invalid | Invalid email address, please try again. | Displays beneath email.username field if invalid entry. |
Create Account Page Language Strings
...
String Resource | Current Value | Placement |
account.create.createaccount | Create an Account | Top of create account page |
account.create.description | Already have an account? | Displays beneath page title. Text area is collapsed if no text is entered. |
account.create.accountexists.signin | Sign in [URL] | active url after “Already have an account” text |
account.create.informationmissing | We found you but additional information is required to create an account. Please contact ###-###-#### or email ___@ ___.com to recover your account | Displays below email field. |
account.create.underage | You must be {0} years of age to register. | Displays below email field. |
Claim Account Language Strings
String Resource | Current Value | Placement |
account.claim.selectaccount | Select Account | Title displays at top page |
account.claim.description | We found two or more accounts that match information you entered. Please select an account to continue. | Description displays beneath title. If no text is entered, this text box will collapse. |
account.claim.select | Select Account | Displays beneath description and above selection dropdown. |
account.claim.verify.description | We found a matching account. Please select a delivery method for your verification code. | Description displays beneath title. If no text is entered, this text box will collapse. |
account.claim.select | Select Account | Displays beneath description and above selection dropdown. |
Force Password Reset (Only if setting PasswordExpirationEnabled is true) Language Strings
...
String Resource | Current Value | Placement |
account.login.resetpassword | Reset password | Displays at bottom of login page |
account.forgotpassword.forgotpassword | Forgot Password | Displays top of reset password page |
account.forgotpassword.description | To reset your password, please enter your email or username and select continue." | Displays beneath title, if no description is entered area is collapsed. |
account.forgotpassword.username | Email or username | Displays beneath description above entry field. |
account.forgotpassword.validation.success | Success! An email and link for resettning your password has been sent to this address. | Displays beneath email.username field after password reset email is sent. |
account.forgotpassword.validation.invalid | Invalid email address, please try again. | Displays beneath email.username field if invalid entry. |
account.resetpassword.resetpassword | Reset Password | Title displays when user taken from email link to reset password page. |
account.resetpassword.description | Please enter and confirm password below. | Description displays beneath reset password title, if no text is entered, description box collapses. |
account.resetpassword.password | Password | Displays beneath description above password field. |
account.resetpassword.confirmpassword | Confirm Password | Displays above confirm password field. |
account.resetpassword.validation.invalid | Password must contain at least 6 characters, a lower case character, an upper case character, at least one digit, and a non-alphanumeric character. | Displays beneath password fields if entry is invalid. |
account.passwordexpired.passwordexpired | Password Expired | |
account.passwordexpired.description | Your current account password has expired. To reset your password, please enter your email or username and select continue. |
Login → Force Reset Password
account.passwordexpired.username | Email or username |
Login → Force Reset Password
account.passwordexpired.validation.success
Success! An email and link for resetting your password has been sent to this address.
Login → Force Reset Password
account.passwordexpired.validation.invalid
Detailed Setup Guide
1. Configure Theming for Identity
...