RoleCollection Class Methods

For a list of all members of this type, see RoleCollection members.

Public Methods

	Name	Description
	Deactivate	Mark the currently active role as no longer active. Any settings (including General Settings, data object or folder tenancy, etc...) changed by activating the role will remain in place until the session ends.
	GetRole	Retrieve a Role object from the collection by ID.
	NewRole	Create and return a new Role object with the ID id, add it to the Role collection and then mark it as the active role without applying its General settings changes to the system. If id is not provided, a GUID will be used for the role's ID.

Name

Description

Mark the currently active role as no longer active.

Any settings (including General Settings, data object or folder tenancy, etc...) changed by activating the role will remain in place until the session ends.

GetRole

Retrieve a Role object from the collection by ID.

NewRole

Create and return a new Role object with the ID id, add it to the Role collection and then mark it as the active role without applying its General settings changes to the system.

If id is not provided, a GUID will be used for the role's ID.

Top

Reference

RoleCollection Class
WebReports.Api.Roles Namespace

Version: 2021.2.6 Last published: 5/18/2022

Contact Exago Support