UserManagerServicesCreateNewGroup Method

public XHRServiceResponseGeneric<CreateNewGroupResult> CreateNewGroup(
	SaveGroupInput data
)

Public Function CreateNewGroup ( 
	data As SaveGroupInput
) As XHRServiceResponseGeneric(Of CreateNewGroupResult)

public:
virtual XHRServiceResponseGeneric<CreateNewGroupResult^>^ CreateNewGroup(
	SaveGroupInput^ data
) sealed

abstract CreateNewGroup : 
        data : SaveGroupInput -> XHRServiceResponseGeneric<CreateNewGroupResult> 
override CreateNewGroup : 
        data : SaveGroupInput -> XHRServiceResponseGeneric<CreateNewGroupResult> 

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

Copy

{
    "data": {
        "info": {
            "newEntry": true,
            "name": "Reviewer",
            "permissions": [1879689, 1673]
        },
        "users": [],
        "ignoreExistingGroup": false
    }
}

Examples

Sample JSON input - Updating existing User Group

JavaScript

Copy

{
    "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

Basic information of the newly created User Group

Examples

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

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.

Reference