Aller au contenu principal

Implémenter Basic Auth

Permettre à l'API d'être consommée par l'API gateway via une authentification Basic Auth.

Cas d'usages​

Ancienne API Tracéo.

Principe de fonctionnement​

L'API déclare dans son raccordement les données relatives au Basic Auth sous le namespace basicAuth dans les données optionnelles (extra). Les attributs du namespace basicAuth sont les suivants :

  • pass (string) : Mot de passe de l'utilisateur Okapi API Gateway (automatiquement masqué lors de l'export)

  • sendImmediately (boolean) : détermine si le header d'authentification doit être envoyé directement. Setté à false, l'API Gateway enverra une première requête sans le header. Si cette requête reçoit une réponse 401, l'API Gateway va renvoyer une requête avec le header d'autorisation

  • user (string) : Nom de l'utilisateur Okapi API Gateway

Configuration dans le raccordement de l'API​

- type: environment
  value:
    value: production # sandbox, ou tout autre environnement
    urlContext: monapi
    version: '1'
    ...
    extra:
      basicAuth:
        user: <USERNAME>
        pass: <PASSWORD>
        sendImmediately: true