role.update
Description
object role.update(object/array roles)
Cette méthode permet de mettre à jour les rôles existants.
Cette méthode est seulement disponible pour les utilisateurs du type Super admin. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres de rôle d'utilisateur. Voir Rôles utilisateur pour plus d'informations.
Paramètres
(object/array) Propriétés du rôle à mettre à jour.
La propriété roleid doit être définie pour chaque rôle, toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.
En plus des propriétés de rôle standard, la méthode accepte les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| rules | array | Règles d'accès en remplacement des règles d'accès actuelles assignées au rôle. |
Valeurs retournées
(object) Retourne un objet contenant les identifiants des rôles mis à jour sous la propriété roleids.
Exemples
Désactivation de la possibilité d'exécuter des scripts
Mettre à jour le rôle avec l'ID "5", désactiver la possibilité d'exécuter des scripts.
Requête :
{
"jsonrpc": "2.0",
"method": "role.update",
"params": [
{
"roleid": "5",
"rules": {
"actions": [
{
"name": "execute_scripts",
"status": "0"
}
]
}
}
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"roleids": [
"5"
]
},
"id": 1
}Limiter l'accès à l'API
Mettre à jour le rôle avec l'ID "5", refuser d'appeler les méthodes "create", "update" ou "delete".
Requête :
{
"jsonrpc": "2.0",
"method": "role.update",
"params": [
{
"roleid": "5",
"rules": {
"api.access": "1",
"api.mode": "0",
"api": ["*.create", "*.update", "*.delete"]
}
}
],
"auth": "3a57200802b24cda67c4e4010b50c065",
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"roleids": [
"5"
]
},
"id": 1
}Source
CRole::update() dans ui/include/classes/api/services/CRole.php.