Drupal REST & JSON API Authentication module restricts and secures unauthorized access to your Drupal site APIs using different authentication methods including Basic Authentication , API Key Authentication , JWT Authentication , OAuth Authentication , External / Third-Party Provider Authentication, etc

A REST API defines a set of functions in which developers can perform requests such as GET, POST, PUT, PATCH, DELETE, and receive responses via HTTP protocol. For example, when a client application calls a Drupal API to fetch a specific user (the resource), the API will return the state of that user, including their name, email, user id, etc.

Know more Setup Guide Our unique case-studies

What are the different authentication methods that our module supports:

The Drupal REST & JSON API authentication module provides the below methods for authenticating all your Drupal APIs:

1) API Key Authentication: If you want to protect your Drupal REST APIs from unauthenticated users but you don’t want to share users login credentials or client id and secret to authenticate the REST API, then you can use API Key authentication, which will generate a random authentication key for you. Using this key, you can authenticate any APIs on your site

2) Basic Authentication : If you want to protect your Drupal REST APIs with the user's login credentials, then you can opt for this method. It is recommended that you should use this method on HTTPS or secure socket layers.

3) JWT Authentication : If you are looking to protect your REST APIs using the JWT token and if you do not have any third party provider/identity provider that issues the JWT token, then you should go for the JWT Authentication method. In this case, our Drupal REST API Authentication itself issues the JWT token and works as an API Authenticator to protect your REST APIs.

4) OAuth 2.0 Authentication: If you are looking for protecting your REST APIs using the access token and at the same time you do not have any third-party provider/identity provider, then you should go for OAuth 2.0 Authentication method. In this scenario, our Drupal REST API Authentication works as both OAuth Server and API Authenticator to protect your REST APIs.

5) Third-Party Provider Authentication: If you are looking for protecting/restricting access to your Drupal REST APIs using your OAuth Provider/Identity provider, then you should go for the Third Party Provider Authentication method. In this method, you just need to configure the module with the User Info Endpoint provided by your Identity Provider and you will be able to authenticate the API Request using the token provided by your provider.

This module is compatible with both REST and the JSON API module and even support authentication for custom APIs


Features Supported (please note that not all features are supported in the free version of the module)

  • Supports JSON API module
  • Supports REST APIs
  • Supports Restriction of Custom APIs
  • API Key Authentication
  • Basic Authentication
  • Access Token Authentication
  • JWT Authentication
  • OAuth 2 Authentication
  • Generate separate API Keys for every user
  • Custom Header
  • Custom Token Expiry
  • Custom API Restrictions
  • IP Address Based Restriction
  • Role Based Restriction
  • and much more...



24/7 Support:
If you require any sort of help or assistance in installing or configuring this module, please feel free to reach out to us on our 24*7 support at drupalsupport@xecurify.com or Contact us

About Us
Check out our website https://www.miniorange.com/ or Click here to see all our listed Drupal modules. For more support or information, please email us at info@xecurify.com or Contact us. You can also submit your query from the module’s configuration page as well.

Installation:

  • Using Composer:

    1. composer require drupal/rest_api_authentication
    2. Go to Extend menu on your Drupal admin console and enable the module by checking the checkbox and click on install button.
    3. Configure the module at {BaseURL}/admin/config/people/rest_api_authentication/auth_settings
  • Using Drush:

    1. Download the module: drush dl rest_api_authentication
    2. Install the module: drush en rest_api_authentication
    3. Clear the cache: drush cr
    4. Configure the module at {BaseURL}/admin/config/people/rest_api_authentication/auth_settings
  • Manual installation:

    1. Go to Extend menu on your Drupal admin console and click on Install new module.
    2. Install the Drupal Drupal REST & JSON API Authentication module either by downloading the zip or from the URL of the package(tar/zip).
    3. Click on Enable newly added modules.
    4. Enable this module by checking the checkbox and click on install button.
    5. Configure the module at {BaseURL}/admin/config/people/rest_api_authentication/auth_settings


Supporting organizations: 

Project information

Releases