ActiveRoleId Property

Get or set the ID (name) of the active role. Setting the ActiveRoleId will also activate the role.

Syntax

public System.string ActiveRoleId {get; set;}

The name of one of the roles in the system configuration.

Exceptions

Exception	Description
System.NullReferenceException	A System.NullReferenceException will be thrown when Exago attempts to create the session and the ID of the role does not exist in the configuration.

Remarks

Once activated, it is not possible to deactivate a role in the API.

Example

Set the active role to "Restricted User"

api.General.ActiveRoleId = "Restricted User";

Version: 2021.2.6 Last published: 5/18/2022