OAuth 2 Scopes

In OAuth 2.0, applications are granted access to limited subsets of user data. These are called scopes (not to be confused with Liferay scopes). You can create them in two ways:

• Administrators can create a Service Access Policy for the scope.

• Developers can create a JAX-RS endpoint. By default, the JAX-RS endpoint generates scopes based on the HTTP verbs it supports. A special annotation overrides this behavior and registers specific scopes.

Creating a Scope for a JSONWS Service

The most common way to create a scope is to create a Service Access Policy prefixed with the name OAUTH2_. This naming convention causes the policy to appear in the OAuth application configuration screen as a scope.

For example, say the application needs access to a user’s profile information to retrieve the email address. To grant the application access to this,

1. Go to Control Panel → Security → Service Access Policy,

2. Create a policy per the information below.

   Field	Value
   Name	OAUTH2_userprofile
   Enabled	True
   Default	False
   Title	read your personal user data
   Service Class	com.liferay.portal.kernel.service.UserService
   Method Name	getCurrentUser

   

   Note that the policy is not a default policy, and that it grants access only to one method in the UserService. This is a JSONWS web service generated by Service Builder. You can view a list of all available services in your installation at this URL: http://[host]:[port]/api/jsonws/

3. Go to Control Panel → Security → OAuth2 Administration.

4. Select Fragment Renderer.

   When you create a policy and prefix it with OAUTH2_, it appears in the Scopes tab.

   

5. You can find the newly created scope under PORTAL SERVICES and save your application.

Note

There’s another scope called read your personal user data. This is one of the many out-of-the-box scopes that comes with Liferay.

Creating the Authorization Page

This step is optional. Users need an interface to authorize access to their accounts, and one is provided automatically. If, however, you want to customize the page, you can create an authorization page in your Site.

1. Open the Global Menu (), click the Control Panel tab, and go to Instance Settings → Security → OAuth 2 → Authorize Screen.

   This screen displays the Authorize Screen URL field with this default value: /?p_p_id=com_liferay_oauth2_provider_web_internal_portlet_OAuth2AuthorizePortlet&p_p_state=maximized. This corresponds to an internal portlet.

   

2. Set the desired URL for the Authorize Screen (e.g., /authorize).

3. Navigate to the desired Site and open the Site Menu (), expand Site Builder, and click Pages.

4. Click the Add button () button and choose Page.

   note

   For Liferay DXP 7.3 and earlier, create a Private Page. Only authenticated users can access Private Pages.

5. Choose the Full Page Application type.

6. Give the page the same name you configured in step 2.

7. Turn the Hidden from Navigation Menu Widget switch on. You don’t want this page showing up in your Site navigation.

8. On the page that appears next, verify the Friendly URL matches the URL you configured in step 2.

9. Under Full Page Application, choose Application Authorization Request.

10. Click Save.

Excellent! Users can use the default or the UI of your design to go through the authorization process. Now that you have the UI and you understand scopes, it’s time to make the authorization process happen in your application.