docs-v2/content/flux/v0/stdlib/http/basicauth.md

1.8 KiB

title description menu weight introduced
http.basicAuth() function `http.basicAuth()` returns a Base64-encoded basic authentication header using a specified username and password combination.
flux_v0_ref
name parent identifier
http.basicAuth http http/basicAuth
101 0.44.0

http.basicAuth() returns a Base64-encoded basic authentication header using a specified username and password combination.

Function type signature
(p: string, u: string) => string

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

u

({{< req >}}) Username to use in the basic authentication header.

p

({{< req >}}) Password to use in the basic authentication header.

Examples

Set a basic authentication header in an HTTP POST request

import "http"

username = "myawesomeuser"
password = "mySupErSecRetPasSW0rD"

http.post(
    url: "http://myawesomesite.com/api/",
    headers: {Authorization: http.basicAuth(u: username, p: password)},
    data: bytes(v: "Something I want to send."),
)