Groups - create

Use this command to create a group.

Format:


admin.groups.create({<propertyName>:<value>,....})

Example:


>>> admin.groups.create({"name": "test1","description": "test1"})

The response is similar to the following example:


{
   "created_time": "Mon, 16 Jan 2012 08:32:55GMT",
   "description": "test1",
   "name": "test1",
   "updated_time": "Mon, 16 Jan 2012 08:32:55GMT"
}

Using the skipNameValidation option

The following special characters are no longer supported for use in new user group names:

# < > / : ; { } \ & +

Note that if you upgraded from a previous version of IBM Cloud Pak System, any user group names that were created with these special characters before upgrading are unaffected by this change. New user group names that you create are checked to ensure that these special characters are not used.

If you have a particular requirement to specify new user group names that do include these unsupported special characters, you can still create the user group name using this CLI command and a special skipNameValidation option. This is a Boolean value that, when set to True, disables the validation check at the time the user group name is created.

Important: This is not a recommended best practice, and this option is offered only for use in special circumstances when you must use a user group name that includes these unsupported characters. You should evaluate your user group names and consider deprecating, changing, or removing these names as needed.

The following example shows a user group name test1\test2 being created, using an unsupported special character and the skipNameValidation option set to True:

>>> admin.groups.create({"name": "test1\test2","description": "test1 and test2","skipNameValidation":True})