v2.1 Authentication Support

Authentication Support

Authentication can easily be handled when using the API Platform’s admin library. In the following section, we will assume the API is secured using JWT, but the process is similar for other authentication mechanisms. The login_uri is the full URI to the route specified by the firewalls.login.json_login.check_path config in the JWT documentation.

The first step is to create a client to handle the authentication process:

// src/authClient.js
import { AUTH_LOGIN, AUTH_LOGOUT, AUTH_ERROR, AUTH_CHECK } from 'admin-on-rest';

// Change this to be your own login check route.
const login_uri = 'https://demo.api-platform.com/login_check';

export default (type, params) => {
  switch (type) {
    case AUTH_LOGIN:
      const { username, password } = params;
      const request = new Request(`${login_uri}`, {
        method: 'POST',
        body: JSON.stringify({ email: username, password }),
        headers: new Headers({ 'Content-Type': 'application/json' }),

      return fetch(request)
        .then(response => {
          if (response.status < 200 || response.status >= 300) throw new Error(response.statusText);

          return response.json();
        .then(({ token }) => {
          localStorage.setItem('token', token); // The JWT token is stored in the browser's local storage

    case AUTH_LOGOUT:

    case AUTH_ERROR:
      if (401 === params.status || 403 === params.status) {

        return Promise.reject();

    case AUTH_CHECK:
      return localStorage.getItem('token') ? Promise.resolve() : Promise.reject();

          return Promise.resolve();

Then, configure the Admin component to use the authentication client we just created:

// src/Admin.js
import React, { Component } from 'react';
import { HydraAdmin, hydraClient, fetchHydra } from '@api-platform/admin';
import authClient from './authClient';

const entrypoint = 'https://demo.api-platform.com';

const fetchWithAuth = (url, options = {}) => {
  if (!options.headers) options.headers = new Headers({ Accept: 'application/ld+json' });

  options.headers.set('Authorization', `Bearer ${localStorage.getItem('token')}`);
  return fetchHydra(url, options);

const restClient = (api) => (hydraClient(api, fetchWithAuth));

export default class extends Component {
  render() {
    return <HydraAdmin entrypoint={entrypoint} restClient={restClient} authClient={authClient}/>;

Refer to the chapter dedicated to authentication in the Admin On Rest documentation for more information.

You can also help us improve the documentation of this page.

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop