Skip to content

HTTP Basic Auth

Parameters for HTTP connections with basic authentication (RFC 7617).


General Information:

Type ID Module Category
2 httplib api

BasicAuthConnectionParams

Parameters:

  • username : str

Input Parameters:

Field Type Required Description Default value Examples
url HttpUrl Service endpoint full URL PydanticUndefined https://api.example.com/endpoint
headers Optional[dict[str, str]] Additional HTTP headers to include in the request None {"Authorization": "Bearer token", "Content-Type": "application/json"}
method Literal[GET, POST, PUT, DELETE, PATCH] HTTP method to use GET POST
body Optional[dict[str, Any]] JSON body of the request None {"key": "value"}
verify_ssl bool Whether to validate the SSL certificate True True
username str Username for basic authentication PydanticUndefined myuser
password str Password for basic authentication PydanticUndefined mypassword

Example:

{
  "url": "https://api.example.com/protected",
  "username": "myuser",
  "password": "mypassword",
  "headers": {
    "Content-Type": "application/json"
  },
  "method": "GET",
  "body": null,
  "verify_ssl": true
}

Notes:

Basic authentication sends credentials in encrypted plain text