user.update

Descripción

object user.update(object/array users)

Este método permite actualizar los usuarios existentes.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener más información.

La seguridad de la contraseña del usuario se valida de acuerdo con las reglas de política de contraseñas definidas por la API de autenticación. Consulte API de autenticación para obtener más información.

Parámetros

(objeto/matriz) Propiedades del usuario que se actualizarán.

La propiedad userid debe definirse para cada usuario, todos los demás Las propiedades son opcionales. Sólo se actualizarán las propiedades pasadas, todas otros permanecerán sin cambios.

Además de las [propiedades de usuario estándar] (objeto#usuario), el método Acepta los siguientes parámetros.

Parámetro Tipo Descripción
current_passwd string Contraseña actual del usuario.

El valor de este parámetro puede ser una cadena vacía si el usuario está vinculado a un directorio de usuarios.< br>
Comportamiento de parámetros:
- solo escritura
- obligatorio si contraseña de objeto de usuario está configurado y el usuario cambia su propia contraseña de usuario
usrgrps array Grupos de usuarios para reemplazar los grupos de usuarios existentes.

Los grupos de usuarios deben tener solo la propiedad usrgrpid definida.
medias array User media para reemplazar los medios existentes no aprovisionados. Los medios proporcionados se pueden omitir al actualizar los medios.

Valores de retorno

(objeto) Devuelve un objeto que contiene los ID de los usuarios actualizados bajo la propiedad userids.

Ejemplos

Cambiar el nombre de un usuario

Cambie el nombre de un usuario a John Doe.

Solicitud:

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

Respuesta:

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

Cambiar rol de usuario

Cambiar el rol de un usuario.

Solicitud:

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

Respuesta:

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

See also

-Authenticación

Fuente

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