User Management
Module Version 1.6.6.0
Overview#
This module is used to manage user accounts at the Tenant level.
Roles#
| Role | Purpose |
|---|---|
| UserManager | Create and edit Users, set system access level for each user, view full user profiles |
| UserActivityLogger | Log customised activity data |
| UserActivityViewerMeOnly | View logged customised activity data |
Settings#
The module exposes a number of settings allow customisation of function and behaviour
| Name | Type | Default Value | Purpose |
|---|---|---|---|
| AccountInvitationEmailSubject | String | Account invitation | Email subject string for new user account invitation |
| AccountInvitationTimeoutInMinutes | Integer | 1440 | Expiry of new user account invitation in minutes |
| AccountVerificationEmailSubject | String | Account verification | Email subject string for new user account verification |
| AccountVerificationTimeoutInMinutes | Integer | 1440 | Expiry of new user account verification in minutes |
| AuthorisedRolesCsv | String | UserActivityViewerMeOnly, UserActivityLogger, UserManager |
List of roles allowed to access this interface in the EMS portal |
| HeadingText | String | User Management | Heading text shown in the EMS portal |
| IsEnabled | Boolean | true | Toggle visibility of this module’s interfaces and APIs for all users in the EMS portal |
APIs#
Management APIs#
The following APIs can be accessed by a user with role UserManager. For Tenant level APIs the value of {id} in the relative URL defaults to “0”
| Name, URL, Type, API Version | Roles | Purpose |
|---|---|---|
| List /{tenant}/api/ManageUser/List/{id} (API Version 2) |
UserManager | Retrieve a list of users based on specific search parameters. |
| GetPersonaForUser /{tenant}/api/ManageUser/GetPersonaForUser/{id} GET (API Version 2) |
UserManager | Retrieve all assigned persona information for a specific user |
| SendAccountInvitation /{tenant}/api/ManageUser/SendAccountInvitation/{id} POST (API Version 2) |
UserManager | Send an email account invitation to a specific user |
| Create /{tenant}/api/ManageUser/Create/{id} POST (API Version 2) |
UserManager | Create new user account |
| IsNewUserEntryValid /{tenant}/api/ManageUser/IsNewUserEntryValid/{id} POST (API Version 2) |
UserManager | Check if new user information is entered correctly |
| AvailableRoles /{tenant}/api/ManageUser/AvailableRoles/{id} GET (API Version 2) |
UserManager | Retrieve full list of roles |
| IsUsernameAvailable /{tenant}/api/ManageUser/IsUsernameAvailable/{id} GET (API Version 2) |
UserManager | Check if a username already exists in the tenant space |
| AddPersonaToUser /{tenant}/api/ManageUser/AddPersonaToUser/{id} POST (API Version 2) |
UserManager | Add persona to a specific user account |
| RemovePersonaFromUser /{tenant}/api/ManageUser/RemovePersonaFromUser/{id} POST (API Version 2) |
UserManager | Remove persona from a specific user account |
Read Only APIs#
The following APIs can be accessed by any authenticated user. For Tenant level APIs the value of {id} in the relative URL defaults to “0”
| Name, URL, Type, API Version | Roles | Purpose |
|---|---|---|
| GetMyPersona /{tenant}/api/User/GetMyPersona/{id} GET (API Version 2) |
Any | Retrieve all assigned persona information for the current user account matching the authentication token |
| GetMyAllowedPersona /{tenant}/api/User/GetMyAllowedPersona/{id} GET (API Version 2) |
Any | Retrieve all persona information for personas the current user matching the authentication token can create |
| GetMyChannels /{tenant}/api/User/GetMyChannels/{id} GET (API Version 2) |
Any | Retrieve all channels assigned to current user account matching the authentication token |
User Activity APIs#
The following APIs can be accessed by a user with role UserActivityLogger or UserActivityViewerMeOnly. For Tenant level APIs the value of {id} in the relative URL defaults to “0”
| Name, URL, Type, API Version | Roles | Purpose |
|---|---|---|
| Search /{tenant}/api/UserActivity/Search/{id} POST (API Version 2) |
UserActivityViewerMeOnly | Log customised activity for current user account matching the authentication token |
| LogActivity /{tenant}/api/UserActivity/LogActivity/{id} POST (API Version 2) |
UserActivityLogger | View customised activity log for current user account matching the authentication token |