Group operations
Create Group
Creates a new group.
Signature: def groupcreate(cinfo)
Parameters:
cinfo['groupid'] - Identifier for the group that should be created
cinfo['attributes'] - Attributes that should be set on the new group
Return Value:
ACSuccess 0
ACUnknownError 1
ACOperationNotSupported 2
ACObjectAlreadyExists 6
Remarks:
The agent.stableId, agent.longId, agent.shortId and the agent.addGroupAttr callbacks should be used to return information on the newly created group. See the callback section for full details on the individual callbacks.
Delete Group
Deletes a group.
Signature: def groupdelete(cinfo)
Parameters:
cinfo['groupid'] - The group that should be deleted
Return Value:
ACSuccess 0
ACUnknownError 1
ACOperationNotSupported 2
ACInvalidGroup 12
Group Group Add
Adds a group to a group.
Signature: def groupgroupadd(cinfo)
Parameters:
cinfo['objectid'] - The group that the member group should be added to
cinfo['objchildid'] - The group that should be added as a member
Return Value:
ACSuccess 0
ACUnknownError 1
ACOperationNotSupported 2
ACInvalidUser 7
ACInvalidObject 38
ACAlreadyRelated 39
Group Group Delete
Removes a group from a group.
Signature: def groupgroupdelete(cinfo)
Parameters:
cinfo['objectid'] - The group that the member group should be removed from
cinfo['objchildid'] - The group that should be removed
Return Value:
ACSuccess 0
ACUnknownError 1
ACOperationNotSupported 2
ACInvalidUser 7
ACInvalidObject 38
ACNotRelated 40
Group Owner Add
Adds a user to a group as a group owner.
Signature: def groupowneradd(cinfo)
Parameters:
cinfo['groupid'] - The group the user should be added as an owner to
cinfo['owner'] - The account that should be added as an owner
Return Value:
ACSuccess 0
ACUnknownError 1
ACOperationNotSupported 2
ACInvalidUser 7
ACInvalidObject 38
ACAlreadyRelated 39
Group Owner Delete
Removes an owner from a group.
Signature: def groupownerdelete(cinfo)
Parameters:
cinfo['groupid'] - The group the owner should be removed from
cinfo['owner'] - The user that should be removed as an owner
Return Value:
ACSuccess 0
ACUnknownError 1
ACOperationNotSupported 2
ACInvalidUser 7
ACInvalidObject 38
ACNotRelated 40
Group User Add
Adds a user to a group.
Signature: def groupuseradd(cinfo)
Parameters:
cinfo['acctid'] - The user to be added
cinfo['groupid'] - The group the user should be added to
Return Value:
ACSuccess 0
ACUnknownError 1
ACOperationNotSupported 2
ACInvalidUser 7
ACUserAlreadyGroupMember 13
ACInvalidObject 38
ACAlreadyRelated 39
Group User Delete
Removes a user from a group.
Signature: def groupuserdelete(cinfo)
Parameters:
cinfo['acctid'] - The user to be removed
cinfo['groupid'] - The group the user should be removed from
Return Value:
ACSuccess 0
ACUnknownError 1
ACOperationNotSupported 2
ACInvalidUser 7
ACUserNotInGroup 9
ACInvalidObject 38
ACNotRelated 40
Update Group
Updates the attributes on a group.
Signature: def groupupdate(cinfo)
Parameters:
cinfo['groupid'] - The group that should be updated
cinfo['attributes'] - Attributes that should be set on the group
Return Value:
ACSuccess 0
ACUnknownError 1
ACOperationNotSupported 2
ACInvalidGroup 12
Remarks:
The agent.stableId, agent.longId, agent.shortId and the agent.addGroupAttr callbacks should be used to return information on the updated group. See the callback section for full details on the individual callbacks.