> User group object

The following objects are directly related to the usergroup API.

User group

The user group object has the following properties.

PropertyTypeDescription
usrgrpidstring(readonly) ID of the user group.
name
(required)
stringName of the user group.
debug_modeintegerWhether debug mode is enabled or disabled.

Possible values are:
0 - (default) disabled;
1 - enabled.
gui_accessintegerFrontend authentication method of the users in the group.

Possible values:
0 - (default) use the system default authentication method;
1 - use internal authentication;
2 - use LDAP authentication;
3 - disable access to the frontend.
users_statusintegerWhether the user group is enabled or disabled.

Possible values are:
0 - (default) enabled;
1 - disabled.

Permission

The permission object has the following properties.

PropertyTypeDescription
id
(required)
stringID of the host group to add permission to.
permission
(required)
integerAccess level to the host group.

Possible values:
0 - access denied;
2 - read-only access;
3 - read-write access.

Tag based permission

The tag based permission object has the following properties.

PropertyTypeDescription
groupid
(required)
stringID of the host group to add permission to.
tagstringTag name.
valuestringTag value.