Skip to content

Persona Management

Module Version 1.1.1.0

Overview#

This module is used to manage access levels and permissions for persona user types at the Tenant level.

Roles#

Role Purpose
PersonaManager Create and edit personas, set system access level for each persona, view full persona profiles
PersonaViewer View persona names only

Settings#

The module exposes a number of settings to allow customisation of function and behaviour

Name Type Default Value Purpose
AuthorisedRolesCsv String PersonaViewer,PersonaManager List of roles allowed to access this interface in the EMS portal
HeadingText String Persona 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 PersonaManager. 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/ManagePersona/List/{id}
GET (API Version 2)
PersonaManager Retrieve list of all personas and their full profile
Get
/{tenant}/api/ManagePersona/Get/{id}
GET (API Version 2)
PersonaManager Retrieve full profile of single persona
Create
/{tenant}/api/ManagePersona/Create/{id}
POST (API Version 2)
PersonaManager Create new persona with only Name and Description
UpdateDetails
/{tenant}/api/ManagePersona/UpdateDetails/{id}
POST (API Version 2)
PersonaManager Update name and description of a persona
Delete
/{tenant}/api/ManagePersona/Delete/{id}
POST (API Version 2)
PersonaManager Delete persona by ID
UpdatePermissions
/{tenant}/api/ManagePersona/UpdatePermissions/{id}
POST (API Version 2)
PersonaManager Update permissions of a persona
AddRoleToPersona
/{tenant}/api/ManagePersona/AddRoleToPersona/{id}
POST (API Version 2)
PersonaManager Add a role to a persona
RemoveRoleFromPersona
/{tenant}/api/
ManagePersona/RemoveRoleFromPersona/{id}

POST (API Version 2)
PersonaManager Remove a role from a persona
AvailableRoles
/{tenant}/api/ManagePersona/AvailableRoles/{id}
GET (API Version 2)
PersonaManager Retrieve list of all roles
AddPersonaAccessToPersona
/{tenant}/api/
ManagePersona/AddPersonaAccessToPersona/{id}

POST (API Version 2)
PersonaManager Add persona management access to a persona
RemovePersonalAccessFromPersona
/{tenant}/api/
ManagePersona/RemovePersonaAccessFromPersona/{id}

POST (API Version 2)
PersonaManager Remove persona management access to a persona

Read Only APIs#

The following APIs can be accessed by a user with role PersonaManager or PersonaViewer. 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/Persona/List/{id}
GET (API Version 2)
PersonaManager, PersonalViewer Retrieve list of persona names
Back to top