user.update

Descrizione

object user.update(object/array users)

Questo metodo consente di aggiornare utenti esistenti.

Questo metodo è disponibile per utenti di qualsiasi tipo. I permessi per chiamare il metodo possono essere revocati nelle impostazioni del ruolo utente. Vedere Ruoli utente per ulteriori informazioni.

La robustezza della password dell'utente viene convalidata in base alle regole della policy delle password definite dall'API di autenticazione. Vedere API di autenticazione per ulteriori informazioni.

Parametri

(object/array) Proprietà utente da aggiornare.

La proprietà userid deve essere definita per ciascun utente, tutte le altre proprietà sono facoltative. Verranno aggiornate solo le proprietà passate, tutte le altre rimarranno invariate.

Oltre alle proprietà utente standard, il metodo accetta i seguenti parametri.

Parameter Type Description
current_passwd string Password corrente dell'utente.

Il valore di questo parametro può essere una stringa vuota se l'utente è collegato a una directory utenti.

Comportamento del parametro:
- sola scrittura
- obbligatorio se passwd dell'oggetto User è impostato e l'utente modifica la propria password
usrgrps array Gruppi utenti per sostituire i gruppi utenti esistenti.

I gruppi utenti devono avere definita solo la proprietà usrgrpid.
medias array Supporti utente per sostituire i supporti esistenti non sottoposti a provisioning. I supporti sottoposti a provisioning possono essere omessi durante l'aggiornamento dei supporti.

Valori di ritorno

(object) Restituisce un oggetto contenente gli ID degli utenti aggiornati sotto la proprietà userids.

Esempi

Rinominare un utente

Rinominare un utente in John Doe.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "user.update",
    "params": {
        "userid": "1",
        "name": "John",
        "surname": "Doe"
    },
    "id": 1
}

Risposta:

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

Modifica del ruolo utente

Modificare il ruolo di un utente.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "user.update",
    "params": {
        "userid": "12",
        "roleid": "6"
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": {
        "userids": [
            "12"
        ]
    },
    "id": 1
}

Guarda anche

Fonte

CUser::update() in ui/include/classes/api/services/CUser.php.