Namespace: User

Appearition.User

Use the functions under this module to view users on the Appearition platform.

Namespaces

Activity
Manage

Methods

Appearition.User.GetMyAllowedPersona (requestOptions)Array.<Appearition.Persona.ChannelViewModel> static

Retrieves the allowed persona for the logged in user. Applicable when the logged in user is allowed to manage users and they are presented with a choice of persona they are creating

Name Type Description
requestOptions any

configure callbacks

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

Appearition.User.GetMyChannels (requestOptions)Array.<Appearition.Persona.ChannelViewModel> static

Retrieves the persona for the logged in user

Name Type Description
requestOptions any

configure callbacks

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

Appearition.User.GetMyPersona (requestOptions)Array.<Appearition.User.PersonaViewModel> static

Retrieves the persona for the logged in user

Name Type Description
requestOptions any

configure callbacks

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

Type Definitions

Appearition.User.ChannelViewModel

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

Properties:
Name Type Description
Id string

The unique name of the channel

Name string

Name of the channel

Appearition.User.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.User.PersonaViewModel

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

Properties:
Name Type Description
Name string

The unique name of the persona

Description string

Any text that describes the persona

CanAccessAllRoles boolean

Identifies if user can see all the roles in the system

Roles Array.<string>

A list of roles that are allocated for this persona

CanAccessAllPersona boolean

Identifies if user can see all the persona in the system

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.