viafirma inbox :: manual de integración

Actualizar un usuario

Método para la actualización de un usuario. Si el usuario existe y su rol no es de tipo administrador lo actualiza. Puede consultar la funcionalidad asociada a cada rol en el manual de administración.

  • Tipo: PUT
  • URL: url-inbox/api/v3/users/update
  • Tipo de entrada: application/json
  • Tipo de salida: application/json

Json de entrada

El json de entrada está compuesto por los siguientes campos:

  • userCode: Código (Obligatorio)
  • universalCode: Usuario del directorio activo.
  • name: Nombre (Obligatorio)
  • surname1: Primer apellido (Obligatorio)
  • surname2: Segundo apellido
  • phone: Teléfono
  • entities: Listado de entidades del usuario. Para cada entidad se muestra:
    • entityCode: Código de la entidad.(Obligatorio)
    • email: Correo electrónico del usuario asociado a la entidad.(Obligatorio)
    • isDefault: Indica si es la entidad por defecto del usuario.(Obligatorio)
    • jobs: Listados de cargos del usuario asociados a la entidad. Se debe indicar el código del cargo. Se pueden consultar los cargos disponibles con el servicio listado de cargos.
    • groups: Listados de grupos del usuario asociados a la entidad. Se debe indicar el código del grupo. Se pueden consultar los grupos disponibles con el servicio listado de grupos.
  • cmis: Información del repositorio personal de CMIS. Para instancias que tienen activo un repositorio de CMIS es posible indicar el repositorio personal de un usuario. De forma que el usuario podrá añadir documentos desde este repositorio en la redacción de peticiones. Los datos que se muestran son:
    • pathbase: Path base del repositorio del usuario.
    • folderId: Identificador de la carpeta del usuario.
    • user: Usuario del repositorio CMIS.
    • password: Contraseña del repositorio CMIS.
  • timezone: Zona horaria del usuario. Puede consultar los valores permitidos aquí. Valor por defecto EUROPE_MADRID.
  • locale: Locale del usuario. Posibles valores:

    • ES: Castellano
    • EN: Inglés
    • FR: Francés
    • CA: Catalán
    • EU: Euskera

    Valor por defecto ES.

  • notificationsLevel: Nivel de notificación del usuarios. Posibles valores:
    • HIGH: Se reciben varios correos por petición (para cada lectura, firma o visto bueno).
    • MEDIUM: No se envían los emails de lectura.
    • LOW: Solamente se envían emails de aviso cuando una petición en espera pasa a estar disponible para realizar la acción.
    • NEWSLETTER: Se recibe un boletín con la periodicidad seleccionada, con todas las peticiones recibidas en este periodo (lecturas, firmas o vistos bueno).
  • newsletterFrequencyDays: Para usuario con nivel de notificacin boletín. Indica la periodicidad del boletín en días.
  • isSender: Indica si el usuario tiene permisos para el envío de peticiones. Por defecto true.
  • canSendAllEntity: Para usiarios con permisos de envío de peticiones indica si el usuario puede envíar únicamente a usuarios de sus entidades o a usuarios de todas las entidades. Por defecto true.
  • canDelegate: Indica si el usuario puede delegar su firma/visto bueno.
  • canViewWorkflow: Indica si el usuario puede ver el flujo de firmas de las peticiones en las que participa.
  • isServerSign: Indica si es un usuario de firma automatizada.
  • serverSignAlias: Alias del certificado del usuario de firma automatizada.
  • serverSignPassword: Contraseña del certificado del usuario de firma automatizada.
  • numberIds: Identificadores de los certificados con los que el usuario puede realizar firmas.

Ejemplo de json de entrada

Json de salida

El json de salida será el mismo que el del servicio obtener datos de un usuario

Ejemplo de json de salida