Se encuentra viendo la documentación de la versión en desarrollo, puede estar incompleta.
Esta página fue traducida automáticamente. Si detectas un error, selecciónalo y presiona Ctrl+Enter para informarlo a los editores.

user.update

Descripción

object user.update(object/array users)

Este método permite actualizar usuarios existentes.

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

La fortaleza de la contraseña del usuario se valida según las reglas de la política de contraseñas definidas por la API de Autenticación. Consulte API de Autenticación para más información.

Parámetros

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

La propiedad userid debe definirse para cada usuario, todas las demás propiedades son opcionales. Solo se actualizarán las propiedades pasadas, todas las demás permanecerán sin cambios.

Además de las propiedades estándar del 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.

Comportamiento del parámetro:
- solo escritura
- obligatorio si se establece passwd del objeto Usuario y el usuario cambia su propia contraseña
usrgrps array Grupos de usuarios para reemplazar los grupos de usuarios existentes.

Los grupos de usuarios deben tener definida solo la propiedad usrgrpid.
medias array Medios de usuario para reemplazar los medios existentes no aprovisionados. Los medios aprovisionados pueden omitirse al actualizar los medios.

Valores de retorno

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

Ejemplos

Renombrar un usuario

Renombrar 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 el rol de usuario

Cambiar el rol de un usuario.

Petición:

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

Respuesta:

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

Véase también

Fuente

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