Using Authentication

In all of the examples so far, we’ve been making anonymous requests to our JSON:API endpoints. In many cases this is the path of least resistance, but your site may have resources that are only available to users with certain permissions. Rather than only reading data, you may also want to modify specific data within Drupal. Either of these cases will require authentication. The Drupal API client provides a number of options that make using common Drupal authentication methods trivial.

Within our demo data set, accessing the ‘actions’ resource requires a user with the ‘administer actions’ permission. Let’s see what the response looks like if we try to access this resource anonymously.

JS
Data

import { JsonApiClient } from "@drupal-api-client/json-api-client";

const client = new JsonApiClient(
  "https://drupal-api-demo.party",
);

const actions = await client.getCollection("action--action");

Looking at the response object, the data array is empty. Under the ‘meta’ property, we’ll also see the message ‘Some resources have been omitted because of insufficient authorization.’ Let’s adapt this example to use a variety of authentication methods supported by the client.

Basic Authentication

While many decoupled projects chose alternative authentication methods, the client does support basic authentication provided by Drupal Core.

To use basic authentication, we’ll need to make the following changes when creating an instance of the JsonApiClient class:

import { JsonApiClient } from "@drupal-api-client/json-api-client";

const client = new JsonApiClient("https://drupal-api-demo.party", {
  authentication: {
    type: "Basic",
    credentials: {
      username: process.env.MY_USERNAME,
      password: process.env.MY_PASSWORD,
    },
  },
});

const actions = await client.getCollection("action--action");

After making that change, the necessary headers for basic authentication will be added to all requests made by the client.

OAuth Authentication

A popular choice for handling authentication on Decoupled Drupal projects is the Simple OAuth module.

Client Credentials Grant

To use Simple OAuth with the client credentials grant, make the following changes when creating an instance of the JsonApiClient class:

import { JsonApiClient } from "@drupal-api-client/json-api-client";

const client = new JsonApiClient("https://drupal-api-demo.party", {
  authentication: {
    type: "OAuth",
    credentials: {
      grantType: "client_credentials", // defaults to 'client_credentials' if omitted
      clientId: process.env.MY_CLIENT_ID,
      clientSecret: process.env.MY_CLIENT_SECRET,
    },
  },
});

const actions = await client.getCollection("action--action");

After making that change, the necessary authentication headers will be added to all requests made by the client. The client will also automatically handle negotiating your access token, including refreshing the access token when it expires.

Password Grant

To use Simple OAuth with the password grant, make the following changes when creating an instance of the JsonApiClient class:

import { JsonApiClient } from "@drupal-api-client/json-api-client";

const client = new JsonApiClient("https://drupal-api-demo.party", {
  authentication: {
    type: "OAuth",
    credentials: {
      grantType: "password",
      clientId: process.env.MY_CLIENT_ID,
      clientSecret: process.env.MY_CLIENT_SECRET,
      username: process.env.MY_USERNAME,
      password: process.env.MY_PASSWORD,
    },
  },
});

const actions = await client.getCollection("action--action");

Custom Authentication

While the client may formally support additional authentication methods in the future, we also provide an option to specify a custom authorization header.

import { JsonApiClient } from "@drupal-api-client/json-api-client";

const client = new JsonApiClient("https://drupal-api-demo.party", {
  authentication: {
    type: "Custom",
    credentials: {
      value: `${authScheme} ${authorizationParameters}`,
    },
  },
});

const actions = await client.getCollection("action--action");

The specified value will be added to the Authorization header for all requests made by the client.

Authorization: providedvaluestring

Disabling authentication for a request

It is also possible to disable authentication for a specific request by setting the disableAuthentication option to true when calling individual client methods.

import { JsonApiClient } from "@drupal-api-client/json-api-client";

const client = new JsonApiClient("https://drupal-api-demo.party", {
  authentication: {
    type: "OAuth",
    credentials: {
      clientId: process.env.MY_CLIENT_ID,
      clientSecret: process.env.MY_CLIENT_SECRET,
    },
  },
});

const actions = await client.getCollection("action--action", {
  disableAuthentication: true,
});

Even though the client instance is configured to use authentication, the request to get the actions collection will be made anonymously.

The client does not include any features specific to cookie-based authentication due to cross-domain and client side limitations. However, when used inside of your Drupal site (aka, progressive decoupling), the client will inherit the current user session by automatically including any cookies that are set by Drupal when making requests.

Given the following JavaScript:

import { JsonApiClient } from "https://esm.run/@drupal-api-client/json-api-client";

const client = new JsonApiClient(window.location.origin);
const actions = await client.getCollection("action--action");
console.log("This request requires authentication", actions);

which is loaded as a module within a Drupal library:

api_client_examples:
  js:
    js/api-client-examples.js: { attributes: { type: module } }

In a browser window logged in as a user with the ‘administer actions’ permission, you will see results for the ‘action’ collection. As an unauthenticated in an incognito window you will see no results.