Get Roles

API Type

Web Services

Description

Retrieves a list of all roles in the system.

Syntax

public virtual WFRole[] GetRoles()

Parameters

Name	Description
None	Not Applicable

Output

An array of WFRole objects that includes all roles.

Example

IWFAdminService svc = GetAdminService();

try
	{
    WFRole[] roles = adminService.GetRoles();
    foreach (WFRole role in roles)
        {
        Console.WriteLine("Name = '{0}', Description = '{1}'",role.Name,
        role.Description);
        }
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}

/* This example produces the following results:
Name = 'Administrators' Description = 'Administrators have complete
access to maintain system'
Name = 'Process Runtime Managers' Description = 'Process Runtime
Managers have complete access to manage runtime processes'
Name = 'process definition Designers' Description = 'process
definition Designers have complete access to add, modify and remove process
templates' */

Supported Versions

3.2.0.4 and higher