aw_auth_with: Set authorization options

View source: R/auth.R

aw_auth_withR Documentation

Set authorization options

Description

Get or set various authorization options. If called without an argument, then these functions return the current setting for the requested option (which can be NULL if the option has not been set). To clear the setting, pass NULL as an argument.

aw_auth_with sets the type of authorization for the session. This is used as the default by aw_auth() when no specific option is given.

aw_auth_path sets the file path for the cached authorization token. It should be a directory, rather than a filename. If this option is not set, the current working directory is used instead.

aw_auth_name sets the file name for the cached authorization token. If this option is not set, the default filename is aw_auth.rds

Usage

aw_auth_with(type)

aw_auth_path(path)

aw_auth_name(name)

Arguments

type

The authorization type: 'oauth' or 'jwt'

path

The location for the cached authorization token. It should be a directory, rather than a filename. If this option is not set, the current working directory is used instead. If the location does not exist, it will be created the first time a token is cached.

name

The filename, such as aw_auth.rds for the cached authorization token file. The file is stored as an RDS file, but there is no requirement for the .rds file extension. .rds is not appended automatically.

Value

The option value, invisibly

See Also

aw_auth()


adobeanalyticsr documentation built on Oct. 18, 2022, 5:06 p.m.