mng.CreateGroup

This job creates a new user group. An entry is created in the DB table gruppen. ID and osguid are generated by the job and returned in XML.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Currently not supported — pass 0.

GroupInfo

BASE64

Yes

Properties of the group in XML format (see below).

HasEncoding

BOOL

Yes

GroupInfo contains encoding (e.g., UTF-8).

2. GroupInfo Structure

<AdmInfo>
  <Groups>
    <Group name="Test" profil="0"/>
  </Groups>
</AdmInfo>
Attribute Type Description

id

INT

ID of the group (set by the job)

name

STRING

Name of the group

osguid

STRING

GUID of the group (set by the job)

profil

INT

ID of the profile user assigned to the group

description

STRING

Description of the group

3. Output Parameters

Name Type Dependency Description

GroupInfo

BASE64

—

Properties of the group in XML format — id and osguid are set.

4. Return Value

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

5. 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.