documentation /api provider

Basic Auth

API provider

Connection to an API authenticated by HTTP Basic authentication: every request carries Authorization: Basic and the base64 of <username>:<password>, computed here so each setting holds the plain credential. For an API that takes its key as the username with an empty password, leave password empty.

  • API category: Generic
  • Needs login: No, two-legged: no end-user interaction is required

Configuration parameters

Required

  • username : string; required
    The username, or the API key for an API that takes its key as the username. $VAR references anywhere in the value are substituted from environment variables; write $$ for a literal $.
  • password : string; required
    The password; empty for an API that takes only a key. $VAR references are substituted as in username.

What components can use this API

Concepts:

Ingredients: