Documentation
Table of Contents
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 |
|---|---|---|
| contraseña | cadena | Contraseña del usuario. Puede ser una cadena vacía si el usuario pertenece o se mueve solo a grupos que tienen acceso LDAP. |
| usrgrps | array | Usuario grupos para reemplazar los grupos de usuarios existentes. Los grupos de usuarios deben tener la propiedad usrgrpid definida. |
| medias | array | Medios de usuario para reemplazar los medios existentes. |
| user_medias (deprecated) |
array | Este parámetro está en desuso; utilice medias en su lugar.Usuario media para reemplazar los medios existentes. |
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"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Respuesta:
Cambiar rol de usuario
Cambiar el rol de un usuario.
Solicitud:
{
"jsonrpc": "2.0",
"method": "user.update",
"params": {
"userid": "12",
"roleid": "6"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Respuesta:
See also
Fuente
CUser::update() en ui/include/classes/api/services/CUser.php.