View source: R/methods__client_bearer_req.R
| perform_resource_req | R Documentation |
This is a helper for calling downstream APIs with an access token. It creates
an httr2::request() for the given URL, attaches the right authorization
header for the token type, applies shinyOAuth's standard HTTP defaults, and
performs the request. You can also provide a prebuilt httr2::request() object
as the url argument, in which case this helper will layer token authentication
and any explicit overrides on top of the provided request before performing it.
Use resource_req() if you want to only build the request (and perform it later).
Compared to httr2::req_perform(), this helper adds shinyOAuth-specific
handling for DPoP-bound tokens, including retrying once with a fresh proof when
a DPoP-Nonce challenge is encountered. For non-DPoP tokens, this helper behaves
similarly to httr2::req_perform() but with the package's standard defaults
for retries and redirects.
perform_resource_req(
token,
url,
method = "GET",
headers = NULL,
query = NULL,
follow_redirect = FALSE,
check_url = TRUE,
oauth_client = NULL,
token_type = NULL,
dpop_nonce = NULL,
idempotent = NULL
)
token |
Either an OAuthToken object or a raw access token string. |
url |
Either the absolute URL to call or an |
method |
Optional HTTP method (character). Defaults to "GET". When
the effective token type is |
headers |
Optional named list or named character vector of extra
headers to set on the request. Header names are case-insensitive.
Any user-supplied |
query |
Optional named list of query parameters to append to the URL. |
follow_redirect |
Logical. If |
check_url |
Logical. If |
oauth_client |
Optional OAuthClient. Required when the effective
token type is |
token_type |
Optional override for the access token type when |
dpop_nonce |
Optional DPoP nonce to embed in the proof for this
request. This is primarily useful after a resource server challenges with
|
idempotent |
Optional logical controlling generic transport and
transient-HTTP retries in |
An httr2 response object.
# Make request using OAuthToken object
# (code is not run because it requires a real token from user interaction)
if (interactive()) {
# Get an OAuthToken
# (typically provided as reactive return value by `oauth_module_server()`)
token <- OAuthToken()
# Recommended for most callers: build + perform in one step.
response <- perform_resource_req(
token,
"https://api.example.com/resource",
query = list(limit = 5)
)
# Build only when you need to inspect the request yourself.
request <- resource_req(
token,
"https://api.example.com/resource",
query = list(limit = 5)
)
httr2::req_dry_run(request)
# Or start from your own httr2 request and still let shinyOAuth perform it
# so DPoP nonce retries remain available.
custom_request <- httr2::request("https://api.example.com/resource") |>
httr2::req_headers(Accept = "application/json") |>
httr2::req_url_query(limit = 5)
response <- perform_resource_req(token, custom_request)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.