Table of Contents
User group object
The following objects are directly related to the usergroup API.
User group
The user group object has the following properties.
| Property | Type | Description |
|---|---|---|
| usrgrpid | ID | ID of the user group. Property behavior: - read-only - required for update operations |
| name | string | Name of the user group. Property behavior: - required for create operations |
| debug_mode | integer | Whether debug mode is enabled or disabled. Possible values: 0 - (default) disabled; 1 - enabled. |
| gui_access | integer | Frontend 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. |
| mfa_status | integer | Whether MFA is enabled or disabled for the users in the group. Possible values: 0 - disabled (for all configured MFA methods); 1 - enabled (for all configured MFA methods). |
| mfaid | ID | MFA method used for the users in the group. Property behavior: - supported if mfa_status of Authentication object is set to "Enabled" |
| users_status | integer | Whether the user group is enabled or disabled. For deprovisioned users, the user group cannot be enabled. Possible values: 0 - (default) enabled; 1 - disabled. |
| userdirectoryid | ID | ID of the user directory used for authentication. Property behavior: - supported if gui_access is set to "use the system default authentication method" or "use LDAP authentication" |
Permission
The permission object has the following properties.
| Property | Type | Description |
|---|---|---|
| id | ID | ID of the host group or template group to add permission to. Property behavior: - required |
| permission | integer | Access level to the host group or template group. Possible values: 0 - access denied; 2 - read-only access; 3 - read-write access. Property behavior: - required for create operations |
Tag-based permission
The tag-based permission object has the following properties.
| Property | Type | Description |
|---|---|---|
| groupid | ID | ID of the host group to add permission to. Property behavior: - required |
| tag | string | Tag name. |
| value | string | Tag value. |