Skip to end of banner
Go to start of banner

userGroups

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Availability

This routine is available starting with katl-commons 1.0.

Syntax

userGroups(user)

Description

Returns the groups the selected user belongs to.

Parameters

Parameter name

Type

Required

Description

user

string

yes

Username or userkey of the selected user.

Return

string []

The returned array represents the names of the groups this user belongs to.

Example

Example 1

userGroups("username");

Result: The list of groups that the user with account username belongs to.

Example 2

userGroups(currentUser());

Result: The list of groups that the current user belongs to.

Notes

The look-up is first made after the userkey, then after the username.

See also

  • No labels