mng.EmptyGroup

This job empties a group. All user assignments are deleted from the DB table bgrel.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Indicates through which parameter the group is identified:
0 = sGroupGuid
1 = sGroupId
2 = sGroupName

[sGroupGuid]

STRING

No

GUID of the group

[sGroupId]

STRING

No

ID of the group

[sGroupName]

STRING

No

Name of the group

2. Return Value

(INT): 0 = Job successful, otherwise error code.

3. Required System Role

This job modifies users or groups and therefore requires the calling user to hold system role 4 (Administrator: Configure security system). If this role is missing, the call is rejected with the error code -1040906164; the associated error text reads:

User {username} does not have permission to configure the security system. Please contact your administrator.

The system roles assigned to the calling user can be determined with mng.GetUserRoles; an overview of all roles is available under System Roles. See also Error Codes.