ez.no / documentation / ez publish / technical manual / 5.x / features / rest api / authentication

Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.


eZ Systems has decided to use OAUTH 2.0 as the authentication service for the REST API of eZ Publish. This is configurable and other authentication mechanisms may be used.

Note that for existing eZ Publish 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 eZ Publish administrator should register the REST API application for the OAUTH 2.0 service in the eZ Publish 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 eZ Publish 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.

Geir Arne Waaler (18/01/2011 12:00 pm)

Geir Arne Waaler (15/04/2011 8:41 am)


There are no comments.