[Admin_GroupRemoveUser]
[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 -Username and -Password parameters to authenticate the tag. The tag cannot be used within [Inline] ... [/Inline] tags that authenticate as an administrator.
- Syntax
- Parameters
[Admin_GroupRemoveUser: 'Groupname', 'Username']
[Admin_GroupRemoveUser: 'Groupname', 'Username', -Username='Administrator Username', -Password='Administrator Password']Examples
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']Result:
True
| Tag Link | [Admin_GroupRemoveUser] | Category | Admin |
|---|---|---|---|
| Type | Substitution | Data Source | Any |
| Support | Preferred | Version | 5.0 |
| Output Type | Boolean | Security | Tag |
| Implementation | LCAPI | Sets | Lasso 8.5, Lasso 8.0, Lasso 7.0, Lasso 6.0, Lasso 5.0 |
Please note that periodically LassoSoft will go through the notes and may incorporate information from them into the documentation. Any submission here gives LassoSoft a non-exclusive license and will be made available in various formats to the Lasso community.
LassoSoft Inc. > Home
©LassoSoft Inc 2015 | Web Development by Treefrog Inc | Privacy | Legal terms and Shipping | Contact LassoSoft