Repository files navigation

This add-on gives the following features once added to a CUBA project:

• Provides aUserProfileService with methods for getting and updating the details of the current logged in user (what I call theuser profile)
• Exposes a new REST API endpoint (Richardson Maturity Model - Level 2 compliant), called/rest/nxsecup/v1/userProfile supporting GET (getProfile)and PUT (updateProfile) requests, and a/rest/nxsecup/v1/userProfile/password endpoint supporting POSTrequests for updating the user's password
• Adds auserProfile screen, and corresponding menu item after the Settings one in the Help main menu
• Optionally hides theChange password button from theSettings screen (because that button is replicated in theuserProfile screen)

UPDATE FOR CUBA >= 7.1: This add-on adds a dependency to theREST API add-ononce added to your project.

NOTE: This add-on's repository is officially linked to the main CUBA repository.

You can jump straight to step 2. for instructions on how to add it to your project, oroptionallyyou can choose to add my repository to your project's repositories.

1. [OPTIONAL] Add the following maven repositoryhttps://dl.bintray.com/pfurini/cuba-components to the build.gradle of your CUBA application:

buildscript {        //...        repositories {            // ...            maven {            url  "https://dl.bintray.com/pfurini/cuba-components"        }    }        // ...}

2. Select a version of the add-on which is compatible with the platform version used in your project:

The latest stable version is:3.0.0

3. Install the correct add-on version in your project usingCUBA Studio, or manually by editing yourbuild.gradle file.

PLEASE NOTE that new features are developed only in the latest releases, while only critical bug fixesare back-ported to older ones. Please update your CUBA version as soon as possible, if you are in need ofsome features available only in a recent release (see theCHANGELOG for reference).

N/A - This component does not need any data

NONE

The component behavior can be altered by means of configuration properties, and custom views.

The following properties can be set in*.properties files (typically in yourweb-app.properties file).For programmatic access, use to theUserProfileConfig interface.

The following views are the ones used by default in thedefaultView* application properties.Extend or replace them if the default properties are not suitable for your app.

<viewclass="com.haulmont.cuba.security.entity.User"extends="_minimal"name="user.profile">    <propertyname="loginLowerCase"/>    <propertyname="firstName"/>    <propertyname="lastName"/>    <propertyname="middleName"/>    <propertyname="position"/>    <propertyname="email"/>    <propertyname="language"/>    <propertyname="timeZone"/>    <propertyname="timeZoneAuto"/>    <propertyname="changePasswordAtNextLogon"/>    <propertyfetch="JOIN"name="group"view="_minimal"/>    <propertyfetch="JOIN"name="userRoles">        <propertyfetch="JOIN"name="role"view="_minimal"/>    </property></view><viewclass="com.haulmont.cuba.security.entity.User"name="user.profileUpdate">    <propertyname="firstName"/>    <propertyname="lastName"/>    <propertyname="middleName"/>    <propertyname="position"/>    <propertyname="email"/>    <propertyname="language"/>    <propertyname="timeZone"/>    <propertyname="timeZoneAuto"/>    <propertyname="name"/></view>

If you usePostman (and if you don't, you should), then click the following button to importa collection with all the requests

And here is the public documentation URL:REST API Docs

Every request makes use of the following variables:

HINT: you can paste the following script in theTests tab of the/rest/v2/oauth/token requestto automatically set thebearer variable after a successful auth

var jsonData = JSON.parse(responseBody)pm.environment.set("bearer", jsonData.access_token);

For your convenience, aGet Access Token request is already included in the Postman collection. Only makesure to update thesec-user-profile TEST environment to reflect your app URL (by default thebaseurlvariable is set tohttp://localhost:8080/app/rest)

The following are the methods exposed by theextsec_UserProfileService, through the standardREST API endpoint (/rest/v2/services).

<?xml version="1.0" encoding="UTF-8"?><servicesxmlns="http://schemas.haulmont.com/cuba/rest-services-v2.xsd">    <servicename="extsec_UserProfileService">        <methodname="getProfile"/>        <methodname="updateProfile">            <paramname="user"/>        </method>    </service></services>

The component exposes an alternative REST endpoint (/rest/nxsecup/v1) that aligns best toLevel 2 of theRichardson Maturity Model. It is more resource oriented than the service basedapproach of the official REST API, and it makes use of HTTP verbs correctly.

Here is a brief list of the supported endpoints (please use thePostman collection above to play withthe actual requests in your project):

Theuser-edit-profile screen can be extended in the usual CUBA way, so that you can add/remove/altertheUser entity fields exposed to the user.