You are here

Home » API reference » Key auth 8

README.txt in Key auth 8 

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * SETUP & USAGE
 * Support requests
 * Maintainers


INTRODUCTION
------------

Key auth provides simple key-based authentication on a per-user
basis similar to basic_auth but without requiring
usernames or passwords.

This is ideal for sites that expose consumer-facing APIs
via rest, jsonapi, or something similar.

For a full description of the module, visit the project page:
https://www.drupal.org/project/key_auth


INSTALLATION
------------

 * Run composer to install the dependencies.
   composer require 'drupal/key_auth:^1.0'

 * Install as you would normally install a contributed Drupal module.
   See: https://www.drupal.org/docs/8/extending-drupal-8
   /installing-drupal-8-modules for further information.

 * A more comprehensive installation instruction for
   Drupal 8 can be found at https://www.drupal.org/node/2923804/


SETUP & USAGE
-------------

 * Grant users the 'Use key authentication' permission.
 * Configure the basic settings at admin/config/services/key-auth.
 * Users with adequate permissions can view/update/delete their key at
   user/{user}/key-auth.
 * To use with core rest, enable the key_auth authentication provider for your
   endpoints of choice.
 * To use with jsonapi, no additional configuration is required.
 * If Header detection is enabled, pass in a header with the name chosen in the
   configuration, and a value of your user's key
   (ie, api-key: b9a9a0ee50ceab7191282b51c).
 * If Query detection is enabled, include a query parameter in the endpoint URL
   with the name chosen in the configuration, and a value of your user's key
   (ie, ?api-key=b9a9a0ee50ceab7191282b51c).


SUPPORT REQUESTS
----------------

Before posting a support request, carefully read the installation
instructions provided in module documentation page.

Before posting a support request, check Recent log entries at
admin/reports/dblog

Once you have done this, you can post a support request at module issue queue:
https://www.drupal.org/project/issues/key_auth

When posting a support request, please inform if you were able to see any errors
in Recent log entries.


MAINTAINERS
-----------

Current maintainers:
 * mstef - https://www.drupal.org/u/mstef

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Installation

  6.  * SETUP & USAGE

  7.  * Support requests

  8.  * Maintainers

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. Key auth provides simple key-based authentication on a per-user

  15. basis similar to basic_auth but without requiring

  16. usernames or passwords.

  17. 

  18. This is ideal for sites that expose consumer-facing APIs

  19. via rest, jsonapi, or something similar.

  20. 

  21. For a full description of the module, visit the project page:

  22. https://www.drupal.org/project/key_auth

  23. 

  24. 

  25. INSTALLATION

  26. ------------

  27. 

  28.  * Run composer to install the dependencies.

  29.    composer require 'drupal/key_auth:^1.0'

  30. 

  31.  * Install as you would normally install a contributed Drupal module.

  32.    See: https://www.drupal.org/docs/8/extending-drupal-8

  33.    /installing-drupal-8-modules for further information.

  34. 

  35.  * A more comprehensive installation instruction for

  36.    Drupal 8 can be found at https://www.drupal.org/node/2923804/

  37. 

  38. 

  39. SETUP & USAGE

  40. -------------

  41. 

  42.  * Grant users the 'Use key authentication' permission.

  43.  * Configure the basic settings at admin/config/services/key-auth.

  44.  * Users with adequate permissions can view/update/delete their key at

  45.    user/{user}/key-auth.

  46.  * To use with core rest, enable the key_auth authentication provider for your

  47.    endpoints of choice.

  48.  * To use with jsonapi, no additional configuration is required.

  49.  * If Header detection is enabled, pass in a header with the name chosen in the

  50.    configuration, and a value of your user's key

  51.    (ie, api-key: b9a9a0ee50ceab7191282b51c).

  52.  * If Query detection is enabled, include a query parameter in the endpoint URL

  53.    with the name chosen in the configuration, and a value of your user's key

  54.    (ie, ?api-key=b9a9a0ee50ceab7191282b51c).

  55. 

  56. 

  57. SUPPORT REQUESTS

  58. ----------------

  59. 

  60. Before posting a support request, carefully read the installation

  61. instructions provided in module documentation page.

  62. 

  63. Before posting a support request, check Recent log entries at

  64. admin/reports/dblog

  65. 

  66. Once you have done this, you can post a support request at module issue queue:

  67. https://www.drupal.org/project/issues/key_auth

  68. 

  69. When posting a support request, please inform if you were able to see any errors

  70. in Recent log entries.

  71. 

  72. 

  73. MAINTAINERS

  74. -----------

  75. 

  76. Current maintainers:

  77.  * mstef - https://www.drupal.org/u/mstef