usergroup.create

Opis

object usergroup.create(object/array userGroups)

Ta metoda umożliwia tworzenie nowych grup użytkowników.

Ta metoda jest dostępna wyłącznie dla typu użytkownika Super admin. Uprawnienia do wywoływania tej metody można odebrać w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(object/array) Grupy użytkowników do utworzenia.

Oprócz standardowych właściwości grupy użytkowników metoda przyjmuje następujące parametry.

Parametr Typ Opis
hostgroup_rights object/array Uprawnienia do grup hostów, które zostaną przypisane do grupy użytkowników.
proxies object/array Proxy, które zostaną powiązane z grupą użytkowników.
Proxy muszą mieć zdefiniowaną wyłącznie właściwość proxyid.
proxy_groups object/array Grupy proxy, które zostaną powiązane z grupą użytkowników.
Grupy proxy muszą mieć zdefiniowaną wyłącznie właściwość proxy_groupid.
templategroup_rights object/array Uprawnienia do grup szablonów, które zostaną przypisane do grupy użytkowników.
tag_filters array Uprawnienia oparte na tagach, które zostaną przypisane do grupy użytkowników.
users object/array Użytkownicy, którzy zostaną dodani do grupy użytkowników.

Użytkownik musi mieć zdefiniowaną wyłącznie właściwość userid.

Zwracane wartości

(object) Zwraca obiekt zawierający identyfikatory utworzonych grup użytkowników we właściwości usrgrpids. Kolejność zwróconych identyfikatorów odpowiada kolejności przekazanych grup użytkowników.

Przykłady

Tworzenie grupy użytkowników

Utwórz grupę użytkowników Operation managers z zabronionym dostępem do grupy hostów „2” i dodaj do niej użytkownika.

Request:

{
    "jsonrpc": "2.0",
    "method": "usergroup.create",
    "params": {
        "name": "Operation managers",
        "hostgroup_rights": {
            "id": "2",
            "permission": 0
        },
        "users": [
            {
                "userid": "12"
            }
        ]
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": {
        "usrgrpids": [
            "20"
        ]
    },
    "id": 1
}

Zobacz także

Źródło

CUserGroup::create() w ui/include/classes/api/services/CUserGroup.php.