[comment]: # ({a0f60ec7-a0f60ec7})
# role.update

[comment]: # ({/a0f60ec7-a0f60ec7})

[comment]: # ({473edc13-63875138})
### Descrição

`object role.update(object/array roles)`

Este método permite atualizar funções existentes.

::: noteclassic
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](/manual/web_interface/frontend_sections/users/user_roles)
para mais informações.
:::

[comment]: # ({/473edc13-63875138})

[comment]: # ({d414178e-fa5c3d93})
### Parâmetros

`(object/array)` Propriedades da role a serem atualizadas.

A propriedade `roleid` deve ser definida para cada role, 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 role](object#role), o método
aceita os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|rules|array|Regras de [acesso](object#role-rules) a serem atualizadas para a role.|

[comment]: # ({/d414178e-fa5c3d93})

[comment]: # ({12d196f6-12d196f6})
### Valores de retorno

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

[comment]: # ({/12d196f6-12d196f6})

[comment]: # ({b41637d2-b41637d2})
### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({0832e69f-1ce1fe70})
#### Desabilitando a capacidade de executar scripts

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

[Requisição](/manual/api#performing-requests):

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

Resposta:

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

[comment]: # ({/0832e69f-1ce1fe70})

[comment]: # ({19ad5660-a6349165})
#### Limitando o acesso à API

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

[Requisição](/manual/api#performing-requests):

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

Resposta:

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

[comment]: # ({/19ad5660-a6349165})

[comment]: # ({36db1bd2-36db1bd2})
### Fonte

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

[comment]: # ({/36db1bd2-36db1bd2})