Skip to the content
Documentation

REST API Authentication: comparison of v.1 vs v.2

No ratings yet

Versions Compared

Old Version 1

changes.mady.by.user Dominika Kurek

Saved on Apr 19, 2016

compared with

New Version Current

changes.mady.by.user Dominika Kurek

Saved on Apr 22, 2016

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Comment: layout change

...

The REST API

...

supports two authentication methods

...

: session, and basic. 

  • Session-based authentication is meant to be used for AJAX operations. It will let you re-use the visitor's session to execute operations with their permissions.
  • Basic authentication is often used when writing cross-server procedures, when one remote application executes operations on one/several eZ Platform instances (remote publishing, maintenance, etc).

...

Session-based is the default authentication method

...

, as this is needed for UI.

Session based authentication

This authentication method requires a Session cookie to be sent with each request.

If this authentication method is used with a web browser, this session cookie is automatically available as soon as your visitor logs in. Add it as a cookie to your REST requests, and the user will be authenticated.

Logging in

It is also possible to create a session for the visitor if they aren't logged in yet. This is done by sending a POST request to /user/sessions. Logging out is done using a DELETE request on the same resource.

Info
title More information
Session-based authentication chapter of the REST specifications

HTTP Basic authentication

To enable HTTP Basic authentication, you need to edit app/config/security.yml, and add/uncomment the following block. Note that this is enabled by default.

Code Block
title ezplatform.yml
exponential_rest:
    pattern: ^/api/ezp/v2
    stateless: true
    exponential_http_basic:
        realm: Exponential REST API

Basic authentication requires the username and password to be sent (username:password), based 64 encoded, with each request, as explained in RFC 2617.

Most HTTP client libraries as well as REST libraries do support this method one way or another.

Code Block
language none
title Raw HTTP request with basic authentication
GET / HTTP/1.1
Host: api.example.com
Accept: application/vnd.ez.api.Root+json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

In this topic:

Table of Contents
maxLevel 3

Comments

Add a comment

Comments are read by a moderator before they appear.