viafirma inbox :: manual de integración

Obtener datos de un usuario

Método para la obtener los datos de un usuario a partir de su código.

  • Tipo: GET
  • URL: url-inbox/api/v3/users/{userCode}
  • Tipo de salida: application/json
  • Parámetros:
    • userCode: código de usuario.

Json de salida

El json de salida 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
  • role: Perfil del usuario en la aplicación. Los posibles valores son: USER, ADMIN_FUNCTIONAL, ADMIN_INFRASTRUCTURE, ADMIN_GLOBAL;
  • phone: Teléfono
  • 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.
  • 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í.
  • locale: Locale del usuario. Posibles valores: ES, EN, FR, CA, EU.
  • 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:
  • 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.
  • isActive: Indica si el usuario está activo.
  • delegationsTo : Delegaciones otorgadas por otros usuarios al usuario. Los datos que se muestran son:
    • userCodeTo: Código del usuario que recibe la delegación.
    • userCodeFrom: Código del usuario que otorga la delegación.
    • status: Estado de la delegación. Posibles valores:
      • PENDING: Pendiente de firma por el usuario que delega.
      • SIGNED_FROM: Firmado por el usuario que delega, pero no por el usuario que recibe la delegación.
      • ACTIVE: La delegación está activa.
      • EXPIRED: La delegación ha caducado.
    • permissions: Permisos del usuario. Los valores posibles son:
      • SIGN: Firma, visto bueno y rechazo.
      • APPROVAL: Visto bueno y rechazo.
      • COLLABORATOR: Solo consulta de peticiones.
    • isDeleted: La delegación ha sido eliminada.
    • dateFrom: Fecha de inicio de la delegación.
    • dateTo: Fecha de fin de la delegación.
  • delegationsFrom: Delegaciones otorgadas por el usuario. Los datos que se muestran son los mismos que en el campo delegationsTo.

Ejemplo de json de salida