Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edits/style
Scripting_function


Panel
titleDescription

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

Client permissions restrictions


Panel
titleSyntax

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

Panel
titleCode Examples
Code Block
languagepy
titleCode 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
Panel
titleKeywords

system user getRoles, user.getRoles