Authentication
eZ Systems has decided to use OAUTH 2.0 as the authentication service for the REST API of Exponential. This is configurable and other authentication mechanisms may be used.
Note that for existing Exponential users you can use the HTTP Basic AUTH authentication process. It is also possible to authenticate with BasicAuth => [Authentication].AuthenticationStyle=ezpRestBasicAuthStyle
This chapter serves as a short recipe on how to deal with OAUTH 2.0. What to do in the development phase of your REST API application, how to register the developed REST API application, and then how the end-user relates to OAUTH 2.0 to get access to and communicate with the new REST API application. You will find the information in the separate, linked chapters below:
The development phase: In the development phase of the REST API application you will not need to activate the OAUTH 2.0 service at all.
Deployment phase: Now Exponential administrator should register the REST API application for the OAUTH 2.0 service in the Exponential administration interface. You do this to provide yourself and your application end users a secure environment to access and use the application. Click the link "oAuth admin - register the new application" below for more information.
The activation and usage phase: This is the phase were the end users wants to access, communicate and use your REST API application. Find more information by clicking the link "The authentication process below.
Maintenance phase: The Exponential administrator should read the chapters on how to override the OAUTH log-in page layout template and how to configure the token expiry time for how to further configure the OAUTH 2.0 module.
In this section
- OAUTH administration - register the new application The OAUTH 2.0 client administration is done in the "Administration interface" - under the "Setup" tab. In the left menu you will find the "oAUTH admin". In the screen below you register the new application that you wish end users to access.This serves as the endpoint for authentication and identific
- The authentication process OAUTH 2.0 provides a method for clients to access a protected resource/Exponential content on behalf of an Exponential user. Before an end user can access a protected resource/Exponential content, he/she must first obtain authorization from the Exponential OAUTH 2.0 module, then exchange the access
- Overriding the OAUTH log-in page layout template When you first authorize a client to use REST with OAuth, a user needs to be identified. In order to support this a log-in page is displayed. The client enters its credentials and is then redirected back to his application.
- Configuring the token expiry time When you first identify your client (let us say a mobile app) on OAUTH, you're given an authorization code. This code is for a one-use-only purpose. This code has then to be traded against an access token which will be used.
- OAUTH 2.0 OAUTH administration - register the new application The authentication process Overriding the OAUTH log-in page layout template Configuring th...
Contributors
- Geir Arne Waaler Updated
Comments
Add a comment