Homepage / Doc / Create User Group

Create User Group

The CreateUserGroup method can be utilized to create new user groups in Checkbox. This method will return the group id of the new group that has been created. You can then use this group id for other methods such as “AddUsersToGroup”

class Test
{
    static void Main()
    {
        var client = new UserManagementServiceClient();

        var userGroup = client.CreateUserGroup(authToken, "Test-NewGroup", "Test-NewGroupDescription");

        if (!userGroup.CallSuccess)
        {
            Console.WriteLine(userGroup.FailureMessage);
            return;
        }

        Console.WriteLine("User Group has been created with the ID of {0}", userGroup.ResultData);

        //Always close the client
        client.Close();
    }
}

 

Input Parameters

Parameter Type Description
authToken string Authentication token to validate permission over the data requested
userGroupName string Name of the user group that you want to create
userGroupDescription string Description of the user group that you want to create
November 15, 2016