usergroup.update

Descrição

object usergroup.update(object/array userGroups)

Este método permite atualizar grupos de usuários existentes.

Este método está disponível apenas para o tipo de usuário Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object/array) Propriedades do grupo de usuários a serem atualizadas.

A propriedade usrgrpid deve ser definida para cada grupo de usuários; todas as outras propriedades são opcionais. Somente as propriedades informadas serão atualizadas; todas as demais permanecerão inalteradas.

Além das propriedades padrão do grupo de usuários, o método aceita os seguintes parâmetros.

Parameter Type Description
hostgroup_rights object/array Permissões do grupo de hosts a serem substituídas pelas permissões atuais atribuídas ao grupo de usuários.
templategroup_rights object/array Permissões do grupo de templates a serem substituídas pelas permissões atuais atribuídas ao grupo de usuários.
tag_filters array Permissões baseadas em tags a serem substituídas pelas permissões atuais atribuídas ao grupo de usuários.
users object/array Usuários a serem substituídos pelos usuários atuais atribuídos ao grupo de usuários.

O usuário deve ter apenas a propriedade userid definida.
rights
(deprecated)		 object/array Este parâmetro está obsoleto; use hostgroup_rights ou templategroup_rights em seu lugar.
Permissões a serem atribuídas ao grupo de usuários.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos grupos de usuários atualizados na propriedade usrgrpids.

Exemplos

Habilitando um grupo de usuários e atualizando permissões

Habilite um grupo de usuários e forneça acesso de leitura e gravação para ele aos grupos de hosts "2" e "4".

Requisição:

{
    "jsonrpc": "2.0",
    "method": "usergroup.update",
    "params": {
        "usrgrpid": "17",
        "users_status": "0",
        "hostgroup_rights": [
            {
                "id": "2",
                "permission": 3
            },
            {
                "id": "4",
                "permission": 3
            }
        ]
    },
    "id": 1
}

Resposta:

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

Veja também

Origem

CUserGroup::update() em ui/include/classes/api/services/CUserGroup.php.