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) Propietats de l'usuari a actualitzar.

La propietat userid s'ha d'establir 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ó
passwd string Mot de pas de l'usuari.

Pot ésser una cadena buida si l'usuari pertany a grups amb accés LDAP o es mou només a ells.
usrgrps array Grups d'usuaris substituint els grups existents.

Els grups d'usuaris han de tindre la propietat usrgrpid establerta.
medias array Suports de l'usuari existents.
user_medias
(obsolet)
array Aquest paràmetre és obsolet; si us plau, empreu medias.
Suport de l'usuari per substituir els suports existents.

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"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

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

Canvia el rol d'usuari

canvia el rol d'un usuari.

Petició:

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

Resposta:

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

Veieu també

Font

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