user.update

Descripció

object user.update(object/array users)

Aquest mètode permet actualitzar usuaris.

Aquest mètode és disponible per als usuaris de qualsevol tipus. Els permisos per cridar al mètode es poden revocar a la configuració de rols d'usuaris. Per a més informació, veieu Rols d'usuari.

La fortalesa del mot de pas de l'usuari es valida d'acord amb les regles de la política de mots de pas definida per l'API d'autenticació. Veieu API d'autenticació per obtindre més informació.

Paràmetres

(object/array) Les propietats d'usuari que s'han d'actualitzar.

La propietat userid s'ha de definir per a cada usuari, totes les altres propietats són opcionals. Només s'actualitzaran les propietats aprovades, totes les altres romandran sense canvis.

A més de les propietats d'usuari estàndard, el mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
current_passwd string Mot de pas actual de l'usuari.

El valor d'aquest paràmetre pot ser una cadena buida si l'usuari és vinculat a un directori d'usuari.

Comportament del paràmetre:
- només escriptura
- obligatori si passwd de l'objecte d'usuari és establert i l'usuari canvia el seu mot de pas
usrgrps array Grups d'usuaris per substituir els grups d'usuaris existents.

Els grups d'usuaris han de tindre la propietat usrgrpid definida.
medias array Suports d'usuari per substituir els suports existents i no provisionats. Els suports provisionats es poden ometre quan s'actualitzi el suport.

Valors de retorn

(object) Torna un objecte que contingui els IDs dels usuaris actualitzats sota la propietat userids.

Exemples

Reanomenar un usuari

Reanomena un usuari a "Josep Perarnau".

Petició:

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

Resposta:

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

Canviar el rol d'usuari

Canvia el rol d'un usuari.

Petició:

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

Resposta:

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

Veieu també

Font

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