UserManagerServicesCreateNewGroup Method

Ingeniux CMS Web Services API

Creates a new User Group

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.70
Syntax

public XHRServiceResponseGeneric<CreateNewGroupResult> CreateNewGroup(
	SaveGroupInput data
)

Parameters

data
Type: SaveGroupInput

Object containing the data on the new User Group to be created

Examples

Sample JSON input - Normal User Group Creation
JavaScript
{
    "data": {
        "info": {
            "newEntry": true,
            "name": "Reviewer",
            "permissions": [1879689, 1673]
        },
        "users": [],
        "ignoreExistingGroup": false
    }
}
Examples

Sample JSON input - Updating existing User Group
JavaScript
{
    "data": {
        "info": {
            "name": "netops",
            "id": null,
            "permissions": [1355393, 0]
        },
        "users": ["ingeniux\\aloescher", "ingeniux\\atzickler", "ingeniux\\jime", "ingeniux\\kmosier", "ingeniux\\neggen", "ingeniux\\rdonahue", "ingeniux\\rtaylor", "ingeniux\\slee", "ingeniux\\sriedel", "ingeniux\\shawns", "ingeniux\\sfelix"],
        "ignoreExistingGroup": true
    }
}

Return Value

Type: XHRServiceResponseGenericCreateNewGroupResult

Basic information of the newly created User Group

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "name": "Reviewer",
        "groupId": "UserGroups\/33",
        "pcrsCount": 0,
        "secRootsCount": 0,
        "usersAffected": {
            "added": [],
            "removed": []
        },
        "usersCount": 0,
        "wfDefsCount": 0,
        "existing": false
    }
}
Remarks

If the "ignoreExistingGroup" field of the data parameter is true, and the "id" field of the "info" field of data parameter is provided, will update the existing User Group if exists.

The uses listing of new Group is optional, but if provided, each User Id must be valid, or returns error status.

See Also

Reference