Benutzergruppen-Objekt

Die folgenden Objekte stehen in direktem Zusammenhang mit der usergroup API.

Benutzergruppe

Das Benutzergruppenobjekt verfügt über die folgenden Eigenschaften.

Property Type Description
usrgrpid ID ID der Benutzergruppe.

Eigenschaftsverhalten:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
name string Name der Benutzergruppe.

Eigenschaftsverhalten:
- erforderlich für Erstellungsvorgänge
debug_mode integer Gibt an, ob der Debug-Modus aktiviert oder deaktiviert ist.

Mögliche Werte:
0 - (Standard) deaktiviert;
1 - aktiviert.
gui_access integer Authentifizierungsmethode des Frontends für die Benutzer in der Gruppe.

Mögliche Werte:
0 - (Standard) die systemweite Standardauthentifizierungsmethode verwenden;
1 - die interne Authentifizierung verwenden;
2 - die LDAP-Authentifizierung verwenden;
3 - den Zugriff auf das Frontend deaktivieren.
mfa_status integer Gibt an, ob MFA für die Benutzer in der Gruppe aktiviert oder deaktiviert ist.

Mögliche Werte:
0 - deaktiviert (für alle konfigurierten MFA-Methoden);
1 - aktiviert (für alle konfigurierten MFA-Methoden).
mfaid ID MFA-Methode, die für die Benutzer in der Gruppe verwendet wird.

Eigenschaftsverhalten:
- unterstützt für Benutzer des Typs Super admin
- unterstützt, wenn mfa_status des Authentifizierungsobjekts auf „Enabled“ gesetzt ist
proxy_mode integer Modus für die Handhabung des Zugriffs auf Proxys, die nicht in Proxygruppen enthalten sind.

Mögliche Werte:
0 - Verweigerungsliste;
1 - (Standard) Zulassungsliste.

Eigenschaftsverhalten:
- unterstützt für Benutzer des Typs Super admin.
proxy_group_mode integer Modus für die Handhabung des Zugriffs auf Proxygruppen (und deren Proxys).

Mögliche Werte:
0 - Verweigerungsliste;
1 - (Standard) Zulassungsliste.

Eigenschaftsverhalten:
- unterstützt für Benutzer des Typs Super admin.
users_status integer Gibt an, ob die Benutzergruppe aktiviert oder deaktiviert ist.
Für deprovisionierte Benutzer kann die Benutzergruppe nicht aktiviert werden.

Mögliche Werte:
0 - (Standard) aktiviert;
1 - deaktiviert.
userdirectoryid ID ID des Benutzerverzeichnisses, das für die Authentifizierung verwendet wird.

Eigenschaftsverhalten:
- unterstützt für Benutzer des Typs Super admin
- unterstützt, wenn gui_access auf „use the system default authentication method“ oder „use LDAP authentication“ gesetzt ist

Berechtigung

Das Berechtigungsobjekt hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
id ID ID der Host-Gruppe oder Vorlagengruppe, der eine Berechtigung hinzugefügt werden soll.

Verhalten der Eigenschaft:
- erforderlich
permission integer Zugriffsebene auf die Host-Gruppe oder Vorlagengruppe.

Mögliche Werte:
0 - Zugriff verweigert;
2 - schreibgeschützter Zugriff;
3 - Lese-/Schreibzugriff.

Verhalten der Eigenschaft:
- erforderlich für Erstellungsoperationen

Tag-basierte Berechtigung

Das Objekt für tag-basierte Berechtigungen hat die folgenden Eigenschaften.

Eigenschaft Type Beschreibung
groupid ID ID der Host-Gruppe, der die Berechtigung hinzugefügt werden soll.

Property behavior:
- required
tag string Tag-Name.
value string Tag-Wert.