req_oauth

This is a low-level helper for automatically authenticating a request with
an OAuth flow, caching the access token and refreshing it where possible.
You should only need to use this function if you're implementing your own
OAuth flow.

internal

Tools for creating and modifying HTTP requests, then
performing them and processing the results. 'httr2' is a modern
re-imagining of 'httr' that uses a pipe-based interface and solves
more of the problems that API wrapping packages face.

Hadley Wickham

httr2

Perform HTTP Requests and Process the Responses

Posit Software, PBC 

Maximilian Girlich

req_oauth function

<dl><dt>req</dt>
<dd>A httr2 request object.</dd>
<dt>flow</dt>
<dd>An <code>oauth_flow_</code> function used to generate the access token.</dd>
<dt>flow_params</dt>
<dd>Parameters for the flow. This should be a named list
whose names match the argument names of <code>flow</code>.</dd>
<dt>cache</dt>
<dd>An object that controls how the token is cached. This should
be a list containing three functions:<ul>
<li><code><a href="/link/get()?package=httr2&version=1.0.5" data-mini-rdoc="httr2::get()">get()</a></code> retrieves the token from the cache, returning <code>NULL</code> if not
cached yet.</li>
<li><code>set()</code> saves the token to the cache.</li>
<li><code>clear()</code> removes the token from the cache</li>
</ul></dd></dl>

Arguments

OAuth authentication — req_oauth

<dl>

<dt>req</dt>
<dd>A httr2 request object.</dd>


<dt>flow</dt>
<dd>An <code>oauth_flow_</code> function used to generate the access token.</dd>


<dt>flow_params</dt>
<dd>Parameters for the flow. This should be a named list
whose names match the argument names of <code>flow</code>.</dd>


<dt>cache</dt>
<dd>An object that controls how the token is cached. This should
be a list containing three functions:<ul>
<li><code><a href='https://rdrr.io/r/base/get.html'>get()</a></code> retrieves the token from the cache, returning <code>NULL</code> if not
cached yet.</li>
<li><code>set()</code> saves the token to the cache.</li>
<li><code>clear()</code> removes the token from the cache</li>
</ul></dd>

</dl>

req_oauth: OAuth authentication

Description

Usage

Value

Arguments