GetRole Method

Retrieve a Role object from the collection by ID.

Syntax

public Role GetRole( 
   System.string roleId,
   System.bool forUpdate
)

roleId: The ID of the role to retrieve.
forUpdate: If true, the Role object will be copied into the dynamic configuration file if roleId originates from a static configuration file.

A Role object representing the role requested by ID. If no role with roleId can be found, returns null.

Example

Get a Role object for the system role with ID "End-User"

Role mySessionRole = api.Roles.GetRole("End-User");

Version: 2021.2.6 Last published: 5/18/2022