Setup API Key Authentication in Drupal

Using Basic Authentication

• Scroll down to the API Key Configuration section on the same tab.
• Select Basic Authentication type from the dropdown.
• In the Enter Username text field, type the username for which you want to generate the API key, then click the Generate button.
• Once the API Key is generated, click the Save Configuration button at the bottom of the page.
• If you want to generate key for all users, click the Generate Key for All Users button.

• You have successfully configured the Basic Authentication method.


Note: Use the application-specific unique header when authenticating the API.

• You can now view the generated API key in the API Key field of your user profile.

• If you want end users to also generate their API key, the API key management will be available to them if you enable the permission as shown in the image.

Grant Role Permissions to Create Users

• If needed, you can allow non-admin Drupal roles to create users. To do this, assign the Administer users permission to the desired roles from the Permissions page (/admin/people/permissions) of your Drupal site.

Example

• For better understanding, let’s take an example of using API Key-based authentication with the create user API in Drupal.


Note: The /entity/user API in Drupal is used to create a new user.



• To create a user in Drupal, you need to make a POST request with the user’s Drupal username and the API key issued by the miniOrange REST API Authentication module. The username and API key must be encoded in Base64 format. Refer to the example below to make the call.

HTML Request Format- 



Request: 

POST <your_drupal_base_url>/entity/user?_format=json

Header: 

        AUTH-METHOD: application_id
        Accept: application/json
        Content-Type: application/json
        Authorization: Basic base64encoded<username:api-key>
        (The value should be Base64-encoded in the format: username:api-key.)



Body:

        {
        "name": {
        "value": "<username>"
        },
        "mail": {
        "value": "<email>"
        },
        "pass": {
        "value": "<password>"
        },
        "status": {
        "value": "1"
        }
        }


CURL Request Format-

curl --location --request POST '<your_drupal_base_url>/entity/user?_format=json' \
        --header 'AUTH-METHOD: application_id' \
        --header 'Accept: application/json' \
        --header 'Content-Type: application/json' \
        --header 'Authorization: Basic base64encoded<username:API-key>' \
        --data-raw 
        '{
        "name": [
        { "value": "Username" }
        ],
        "mail": [
        { "value": "email" }
        ],
        "pass": [
        { "value": "Password" }
        ],
        "status": [
        { "value": "1" }
        ]
        }'

• You can also refer to the Postman request image shown below

• A successful response will return the details of the user you created (see the image below).