.. ARIA API authentication, created by
   vtran@aria.fr 01/2021.

Authentification
====================================

ARIA API utilise un mécanisme Token, dérivé à partir de::
   
   rest_framework.authentication.TokenAuthentication
   
classe qui est basée sur le HTTP Authentication protocole.

Usage
-----

Pour que un client s'authentifie, le ``token`` devrait être ajouté dans l'entête HTTP ``Authorization``.
La clé doit être commencée par le mot ``Bearer`` avec un espace qui sépare deux chaînes de caractère. Exemple::

   Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b

Comment obtenir un token
------------------------

Le ``token`` est obtenu en utilisant le service d'authentification

.. http:post:: /api-token/

   :jsonparam login_mdp: Le login et le mot de passe de l'utilisateur

   :reqheader Accept: Le type du contenu de la réponse accepté: `application/json`
   :reqheader Authorization: Le mécanisme d'authentification par Token
   :resheader Content-Type: Le type du contenu de la réponse: `application/json`

   :statuscode 200: OK
   :statuscode 403: Forbidden
   :statuscode 404: Ressource non trouvée
   :statuscode 500: Erreur interne

   **Exemple d'une requête**:

   .. sourcecode:: http

      POST /api-token/ HTTP/1.1
      Host: apibeta.aria.fr/py/v2
      Accept: application/json
      Body: {"username": "LOGIN", "password": "PASSWORD"}

   **Exemple d'une réponse**:

   .. sourcecode:: http

      HTTP/1.1 200 OK
      Allow: POST, HEAD, OPTIONS
      Vary: Accept
      Content-Type: application/json

      {
         "token": "c49cca232s4scd3a9472502d82bc11c7f225c657",
         "id": 4,
         "name": "aria_user",
         "email": "aria_mail@aria.fr",
         "groups": [
            {
               "id": 1,
               "name": "inm"
            }
         ]
      }

Quota d'utilisation
-------------------
Le ``quota`` est attribué à chaque utilisateur. Il est mesuré en MB (1 million d'octets).
C'est la limite de la consommation des services de l'utilisateur par mois.
La ``consommation`` d'un service est la taille en octets de la réponse.

En cas de dépassement de la limite imposée par l'administrateur de l'API, le service retourne le code erreur `403 Forbidden`.