Auth Account and Registrations
Module Version 1.7.1.0
Overview#
This module is used to manage user accounts authentication credentials at the Tenant level.
Roles#
| Role | Purpose |
|---|---|
| AccountPasswordReset | Reset the password for a registered user |
| AccountRegistration | Register new user account |
Settings#
The module exposes a number of settings allow customisation of function and behaviour
| Name | Type | Default Value | Purpose |
|---|---|---|---|
| AccountRegistration.Capture.CompanyName.IsEnabled | Boolean | false | Toggle visibility of Company Name text field on Account Registration pages of EMS |
| AccountRegistration.Capture.ContactPhone.IsEnabled | Boolean | false | Toggle visibility of Contact Phone text field on Account Registration pages of EMS |
| AccountRegistration.Capture.Country.IsEnabled | Boolean | false | Toggle visibility of Country text field on Account Registration pages of EMS |
| AccountRegistration.Capture.OtherFields.IsEnabled | Boolean | false | Toggle visibility of custom text or dropdown fields on Account Registration pages of EMS |
| AccountRegistration.Capture.OtherFields.List | String | Sample Field 1, Sample Field 2|option 1;option 2;option 3 |
Labels and values for custom text fields and dropdown fields on Account Registration pages of EMS. Each field is comma delimited, with dropdown fields label and values separated by “|” and values separated by “;” |
| ApiSessionTokenExpiryInMinutes | Integer | 60 | Expiration limit of session token in minutes |
| ApiSessionTokenIsSlidingExpiration | Boolean | false | Toggle sliding expiration for a session token |
| ApiSessionTokenNeverExpires | Boolean | false | Toggle expiry of a session token |
| AuthorisedRolesCsv | String | AccountRegistration, AccountPasswordReset |
List of roles allowed to access this interface in the EMS portal |
| BlockedRegistrationMessage | String | Registration failed. Please contact support for further assistance | Message displayed by portal and Register API for failed registrations |
| BlockRegistrationWhenNoPackagesAvailable | Boolean | true | Toggle registration block when no packages are available |
| IsEnabled | Boolean | true | Toggle visibility of this module’s interfaces and APIs for all users in the EMS portal |
| IsTandCEnabled | Boolean | true | Toggle Terms and conditions popup in Account Registration pages of EMS |
| PasswordResetTokenExpiryMins | Integer | 60 | Expiration limit of password reset in minutes |
| RequireAccountVerification | Boolean | true | Toggle Account Verification by email requirement |
| TandCUrl | String | [empty] | Alternate webpage URL of terms and conditions displayed in terms and conditions popup of Account Registration pages of EMS |
APIs#
Management APIs#
The following APIs can be accessed by any registered user. For Tenant level APIs the value of {id} in the relative URL defaults to “0”
| Name, URL, Type, API Version | Roles | Purpose |
|---|---|---|
| ChangePassword /{tenant}/api/Account/ChangePassword/{id} POST (API Version 2) |
Any | Change the password for the current user account matching the authentication token |
| AccountStatus /{tenant}/api/Account/AccountStatus/{id} GET (API Version 2) |
Any | Check verification and lock status for the current user account matching the authentication token |
| Authenticate /{tenant}/api/Account/Authenticate/{id} POST (API Version 2) |
N/A | Authenticate a user account’s credentials to receive an authentication token. Please note that this token is only valid with APIs executed with the same user agent |
| MyProfile /{tenant}/api/Account/MyProfile/{id} GET (API Version 2) |
Any | Retrieve user and tenant profile information for the current user account matching the authentication token |
| UpdateMyProfile /{tenant}/api/Account/UpdateMyProfile/{id} POST (API Version 2) |
Any | Modify user information for the current user account matching the authentication token |
| Logout /{tenant}/api/Account/Logout/{id} GET (API Version 2) |
Any | Log out the current user account matching the authentication token |
Security APIs#
The following APIs can be accessed by any registered user with one exception. For Tenant level APIs the value of {id} in the relative URL defaults to “0”
| Name, URL, Type, API Version | Roles | Purpose |
|---|---|---|
| RequestPasswordReset /{tenant}/api/Security/RequestPasswordReset/{id} POST (API Version 2) |
Any | Send a specific user a password reset email with security token |
| ResetPasswordWithToken /{tenant}/api/Security/ResetPasswordWithToken/{id} POST (API Version 2) |
AccountPasswordReset | Reset the password for a user account matching the email password reset security token. Best practice is to use this API in a portal UI with an Anonymous token with role AccountPasswordReset assigned |
| VerifyAccount /{tenant}/api/Security/VerifyAccount/{id} GET (API Version 2) |
Any | Verify a new user account matching the email verification security token. |
Registration APIs#
The following APIs can be accessed by a user with role AccountRegistration. For Tenant level APIs the value of {id} in the relative URL defaults to “0”
| Name, URL, Type, API Version | Roles | Purpose |
|---|---|---|
| Status /{tenant}/api/Registration/Status/{id} GET (API Version 2) |
AccountRegistration | Check verification and lock status for a specific user account |
| Register /{tenant}/api/Registration/Register/{id} POST (API Version 2) |
AccountRegistration | Register a new account |
Third party Authentication (Beta) APIs#
The following APIs can be accessed by any registered user. For Tenant level APIs the value of {id} in the relative URL defaults to “0”
| Name, URL, Type, API Version | Roles | Purpose |
|---|---|---|
| AvailableClients /{tenant}/api/OAuth/AvailableClients/{id} GET (API Version 2) |
Any | Retrieve a list of OAuth 2.0 providers supported by the EMS portal |
| OAuthUri /{tenant}/api/OAuth/OAuthUri/{id} GET (API Version 2) |
Any | Retrieve the URI of a specific OAuth 2.0 provider’s authorization server |
| OAuthCallback /{tenant}/api/OAuth/OAuthCallback/{id} GET (API Version 2) |
Any | Retrieve the URI provided by the OAuth 2.0 provider once authorization has been granted or denied |