admAddUserToGroup

admAddUserToGroup

Syntax

admAddUserToGroup(user, group)

Package

adm

Alias

 

Pkg Usage

addUserToGroup(user, group)

Description

Adds a single user to a group if the user is not already in that group.

Parameters

Parameter name

Type

Required

Description

Parameter name

Type

Required

Description

User

String

Yes

Username or userkey.

Group

String

Yes

Group name.

Return Type

Boolean

Returns "true" if operation succeeded.

Example

admAddUserToGroup("user.3", "Senior Developers");

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

See also

Peacock

Need support? Create a request with our support team.

Copyright © 2005 - 2025 Appfire | All rights reserved.