sf_auth_check: Check that an Authorized Salesforce Session Exists

View source: R/auth.R

sf_auth_checkR Documentation

Check that an Authorized Salesforce Session Exists

Description

Before the user makes any calls requiring an authorized session, check if an OAuth token or session is not already available, call sf_auth to by default initiate the OAuth 2.0 workflow that will load a token from cache or launch browser flow. Return the bare token. Use access_token() to reveal the actual access token, suitable for use with curl.

Usage

sf_auth_check(verbose = FALSE)

Arguments

verbose

logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, along with additional diagnostic information where available.

Value

a Token2.0 object (an S3 class provided by httr) or a a character string of the sessionId element of the current authorized API session

Note

This function is meant to be used internally. Only use when debugging.


salesforcer documentation built on March 18, 2022, 6:26 p.m.