Namespace: Manage

Methods

Appearition.Persona.Manage.AddPersonaAccessToPersona (personaName, accessPersonaName, requestOptions) static

Adds the given role to an existing persona

Name	Type	Description
personaName	string	the name of the persona
accessPersonaName	string	the persona to grant access to the persona
requestOptions	any	configure callbacks

Appearition.Persona.Manage.AddRoleToPersona (personaName, role, requestOptions) static

Adds the given role to an existing persona

Name	Type	Description
personaName	string	the name of the persona
role	string	the role to add to the persona
requestOptions	any	configure callbacks

Appearition.Persona.Manage.Create (request, requestOptions) static

Creates a new persona. Nothing is returned unless there is an error

Name	Type	Description
request	Appearition.Persona.PersonaSummaryViewModel	the details of the new persona to create
requestOptions	any	configure callbacks

Appearition.Persona.Manage.Delete (personaId, requestOptions) static

Deletes the persona from the system. Has no impact to the access of users who are in this persona

Name	Type	Description
personaId	number	since we could be updating the name, this is the unique data store identifier
requestOptions	any	configure callbacks

Appearition.Persona.Manage.Get (personaName, requestOptions)Appearition.Persona.Manage.PersonaViewModel static

Retrieves persona by the given name

Name	Type	Description
personaName	string	the name of the persona
requestOptions	any	configure callbacks

Returns:

Type	Description
Appearition.Persona.Manage.PersonaViewModel	This is returned as part of the success callback function in the requestOptions param

Appearition.Persona.Manage.List (requestOptions)Array.<Appearition.Persona.Manage.PersonaViewModel> static

Retrieves a list of personae that are available to be added to a user

Name	Type	Description
requestOptions	any	configure callbacks

Returns:

Type	Description
Array.<Appearition.Persona.Manage.PersonaViewModel>	This is returned as part of the success callback function in the requestOptions param

Appearition.Persona.Manage.ListAvailableRoles (requestOptions) static

Retrieves a list of roles that can be assigned to a persona

Name	Type	Description
requestOptions	any	configure callbacks

Appearition.Persona.Manage.RemovePersonaAccessFromPersona (personaName, accessPersonaName, requestOptions) static

Removes the given role from an existing persona

Name	Type	Description
personaName	string	the name of the persona
accessPersonaName	string	the persona to remove from the persona
requestOptions	any	configure callbacks

Appearition.Persona.Manage.RemoveRoleFromPersona (personaName, role, requestOptions) static

Removes the given role from an existing persona

Name	Type	Description
personaName	string	the name of the persona
role	string	the role to add to the persona
requestOptions	any	configure callbacks

Appearition.Persona.Manage.UpdateDetails (personaId, request, requestOptions) static

Updates the name and description of an existing persona. Nothing is returned unless there is an error

Name	Type	Description
personaId	number	since we could be updating the name, this is the unique data store identifier
request	Appearition.Persona.PersonaSummaryViewModel	the details of the persona to update
requestOptions	any	configure callbacks

Appearition.Persona.Manage.UpdatePermissions (personaName, request, requestOptions) static

Updates the name and description of an existing persona. Nothing is returned unless there is an error

Name	Type	Description
personaName	string	the name of the persona
request	Appearition.Persona.PersonaPermissionViewModel	the details of the persona to update
requestOptions	any	configure callbacks

Type Definitions

Appearition.Persona.Manage.PersonaPermissionViewModel

This is the data structure that represents all the allowed actions for a persona

Properties:

Name	Type	Description
CanCreateUsers	boolean	Is the persona allowed to create new users
CanEditUserAccount	boolean	Is the persona allowed to modify account information such as passwords
CanEditUserPersonalDetails	boolean	Is the persona allowed to modify personal details such as name and contact email
CanEditUserChannels	boolean	Is the persona allowed to modify what channels a user is allocated to
CanOverrideUserRoles	boolean	Is the persona allowed to manually pick roles when creating/editing a user
ShowAcceptConsentOnUserCreate	boolean	When creating new users, must this persona accept consent.
AcceptConsentDisplayText	string	If the ShowAcceptConsentOnUserCreate=true, this may contain a special label that should be presented to the user as part of the consent process
Permissions	Appearition.Persona.Manage.PersonaPermissionViewModel	Describes what this persona is allowed to do.

Appearition.Persona.Manage.PersonaViewModel

This is the data structure that represents a persona on the platform

Properties:

Name	Type	Description
Id	number	The unique system identifier of the persona
Name	string	The unique name of the persona
Description	string	Any text that describes the persona
Roles	Array.<string>	A list of roles that are allocated for this persona
PersonaAccess	Array.<string>	A list of other personas that this persona has access to
Permissions	Appearition.Persona.Manage.PersonaPermissionViewModel	Describes what this persona is allowed to do.