Tag Link | [Admin_GroupRemoveUser] | Category | Administration |
---|---|---|---|
Type | Substitution | Source Available | No |
Support | Preferred | Version | 5.0 |
Change | Unchanged | Data Source | Any |
Output Type | Boolean | Security | Tag |
Implementation | LCAPI | Sets | Lasso 8.5, Lasso 8.0, Lasso 7.0, Lasso 6.0, Lasso 5.0 |
[Admin_GroupRemoveUser] removes a user from a group. The tag requires two parameters: the name of a group and the name of a user.
The tag returns True if the user could be removed from the group. The tag returns False if the user could not be removed from the group or if the user did not belong to the group.
This tag can be called by a group administrator or by the global administrator. The tag can either be called on a page that has been authenticated using an [Auth_...] tag or accepts optional
[Admin_GroupRemoveUser: 'Groupname', 'Username']
[Admin_GroupRemoveUser: 'Groupname', 'Username',
Required Parameters | |
---|---|
Groupname | The group from which the user should be removed. |
Username | The username of the user which should be removed from the group. |
Optional Parameters | |
-Username | Optional administrator username. |
-Password | Optional administrator password. |
The
To remove a user from a group:
Use the [Admin_GroupRemoveUser] tag. The following example removes the user JohnDoe from the group Accounting.
[Admin_GroupRemoveUser: 'Accounting', 'JohnDoe']
True