Build an authorized httr2 request with Bearer token
Source:R/methods__client_bearer_req.R
client_bearer_req.RdConvenience helper to reduce boilerplate when calling downstream APIs.
It creates an httr2::request() for the given URL, attaches the
Authorization: Bearer <token> header, and applies the package's standard
HTTP defaults (timeout and User-Agent).
Accepts either a raw access token string or an OAuthToken object.
Arguments
- token
Either an OAuthToken object or a raw access token string.
- url
The absolute URL to call.
- method
Optional HTTP method (character). Defaults to "GET".
- headers
Optional named list or named character vector of extra headers to set on the request. Header names are case-insensitive. Any user-supplied
Authorizationheader is ignored to ensure the Bearer token set by this function is not overridden.- query
Optional named list of query parameters to append to the URL.
Value
An httr2 request object, ready to be further customized or
performed with httr2::req_perform().
Examples
# Make request using OAuthToken object
# (code is not run because it requires a real token from user interaction)
if (FALSE) { # \dontrun{
# Get an OAuthToken
# (typically provided as reactive return value by `oauth_module_server()`)
token <- OAuthToken()
# Build request
request <- client_bearer_req(
token,
"https://api.example.com/resource",
query = list(limit = 5)
)
# Perform request
response <- httr2::req_perform(request)
} # }