role.update

Descrição

object role.update(object/array roles)

Este método permite atualizar funções 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 da função a serem atualizadas.

A propriedade roleid deve ser definida para cada função, todas as outras propriedades são opcionais. Apenas as propriedades passadas serão atualizadas, todas as outras permanecerão inalteradas.

Além das propriedades padrão da função, o método aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
rules array Regras de acesso a serem atualizadas para a função.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos papéis atualizados na propriedade roleids.

Exemplos

Desabilitando a capacidade de executar scripts

Atualize a função com ID "5", desabilite a capacidade de executar scripts.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "role.update",
    "params": [
        {
            "roleid": "5",
            "rules": {
                "actions": [
                    {
                        "name": "execute_scripts",
                        "status": "0"
                    }
                ]
            }
        }
    ],
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": {
        "roleids": [
            "5"
        ]
    },
    "id": 1
}

Limitando o acesso à API

Atualize a função com ID "5", negando a chamada de qualquer método "create", "update" ou "delete".

Requisição:

{
    "jsonrpc": "2.0",
    "method": "role.update",
    "params": [
        {
            "roleid": "5",
            "rules": {
                "api.access": "1",
                "api.mode": "0",
                "api": ["*.create", "*.update", "*.delete"]
            }
        }
    ],
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": {
        "roleids": [
            "5"
        ]
    },
    "id": 1
}

Fonte

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