User Commands

• getSystemUsers
• getUserGroups

getSystemUsers

---

Retrieves the list of current users in the environment.

Arguments

Argument Name	Description	Required
emails	A comma-separated list of user email addresses to filter the response by. Only users whose email matches an entry in the list are returned.	Optional
names	A comma-separated list of user names (full or partial) to filter the response by. Each entry is matched case-insensitively against the user's first and last name combined.	Optional
limit	Maximum number of users to return. Default value is 50. Set to 0 to return all users.	Optional

Outputs

Core.User.user_email string

Email address of the user.

Core.User.user_first_name string

First name of the user.

Core.User.user_last_name string

Last name of the user.

Core.User.role_name string

Role name associated with the user.

Core.User.last_logged_in number

Timestamp of when the user last logged in.

Core.User.user_type string

Type of user.

Core.User.groups string

Name of user groups associated with the user, if applicable.

Core.User.scope unknown

Name of scope associated with the user, if applicable.

getUserGroups

---

Retrieves the list of current user emails associated with one or more user groups in the environment. Use this to see who has the permissions granted to a given group.

Arguments

Argument Name	Description	Required
group_names	A comma-separated list of one or more user group names for which to retrieve the associated users.	Required

Outputs

Core.UserGroup.group_name string

Name of the user group.

Core.UserGroup.description string

Description of the user group, if available.

Core.UserGroup.pretty_name string

Name of the user group as it appears in the management console.

Core.UserGroup.insert_time number

Timestamp of when the user group was created.

Core.UserGroup.update_time number

Timestamp of when the user group was last updated.

Core.UserGroup.user_email string

List of email addresses belonging to the users associated with the user group.

Core.UserGroup.source string

Type of user group.