cannectors

authentication

authentication configuration for the http_call module.

one of 4 variants

variant · api-key

propertytypedefaultdescription
typerequired
"api-key"
credentialsrequired
object
  • key · string*API key value or env reference (${VAR}).
  • location · stringWhere to send the key.
  • headerName · stringHeader name when location=header.
  • paramName · stringQuery param name when location=query.

variant · bearer

propertytypedefaultdescription
typerequired
"bearer"
credentialsrequired
object
  • token · string*Bearer token value or env reference (${VAR}).

variant · basic

propertytypedefaultdescription
typerequired
"basic"
credentialsrequired
object
  • username · string*Username or env reference (${VAR}).
  • password · string*Password or env reference (${VAR}).

variant · oauth2

propertytypedefaultdescription
typerequired
"oauth2"
credentialsrequired
object
  • tokenUrl · string*Token endpoint URL.
  • clientId · string*Client ID or env reference (${VAR}).
  • clientSecret · string*Client secret or env reference (${VAR}).
  • scope · stringOAuth2 scopes as a space-separated string (RFC 6749 §3.3).