This function is used in Python Scripting.

Description

Returns a sequence of strings representing all of the roles configured in a specific user source.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.user.getRoles(userSource)

  • Parameters

String userSource - The user source to fetch the roles for.

  • Returns

List - A List of strings that holds all the roles in the user source.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet - Get All Roles
# This example will print a list of all user roles in the default user source.
 
roles = system.user.getRoles("")
for role in roles:
    print role
Keywords

system user getRoles, user.getRoles