dim_login: Creates a token in the Global environment to be use in...

Description Usage Arguments Value Examples

View source: R/dim_login.R

Description

Creates a token in the Global environment to be use in querying Dimensions API.

Usage

1
2
3
4
5
dim_login(
  username,
  password,
  authep = "https://app.dimensions.ai/api/auth.json"
)

Arguments

username

A string containing the account username.

password

A string containing the account password.

authep

A string containing the authorization endpoint URL address. By default 'https://app.dimensions.ai/api/auth.json'.

Value

An API token object. This is assigned directly to the Global environment.

Examples

1
> dim_login(username = 'name@email.com', password = 'yourpassword')

cheneypinata/dslr documentation built on Jan. 6, 2022, 11:27 p.m.