Skip to main content
Version: 8.1

system.user.getRoles

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

TypeParameterDescription
StringuserSourceThe 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

Example #1
# 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