AddUserGroup
Use this service to add a new user group.
Required parameters
USERGROUP resource
Parameter Key | Value Type | Parameter Description |
---|---|---|
groupName | Alphanumeric string |
A unique name for the user group. The maximum length for strings is 10. Invalid characters are: ?!@#$%^&*()+=[]{}|\\/><\"'. BLANK |
MEMBER resource
Parameter Key | Value Type | Parameter Description |
---|---|---|
memberName | Alphanumeric string |
A username or group name. The maximum length for strings is 10. Invalid characters are: ?!@#$%^&*()+=[]{}|/><,;:\"'. BLANK |
memberType | Fixed values |
The type of group member you want to add, either a user or group. The fixed values are USER or GROUP |
Optional parameters
USERGROUP resource
Parameter Key | Value Type | Parameter Description |
---|---|---|
groupDescription | Alphanumeric string |
A short description of the user group. The default value is BLANK and the maximum length for strings is 35. |
XML request format
This is the format of the request XML payload for POST method calls. Note that this must always be wrapped by <ACTION> nodes.
<USERGROUP groupName="XXX" groupDescription="XXX" >
<MEMBER memberName="XXX" memberType="group" />
<MEMBER memberName="XXX" memberType="user" />
</USERGROUP >