oas_build_credentials: Build Credentials String

Description Usage Arguments Value Examples

Description

This function returns a formatted string that should be supplied when making requests to the API to authenticate the user

Usage

1
2
3
oas_build_credentials(account=getOption("roas.account"), 
                         username=getOption("roas.username"), 
                         password=getOption("roas.password"))

Arguments

account

a character string of your OAS account name

username

a character string of your OAS username that has API enabled access permissions

password

a character string of your password for the OAS username specified

Value

A character, formatted as XML, that should be supplied when making requests to the API

Examples

1
2
3
4
5
6
## Not run: 
my_credentials <- oas_build_credentials(account='myaccountname', 
                                    username='myusername', 
                                    password='mypassword')

## End(Not run)

ReportMort/roas documentation built on May 9, 2019, 9:45 a.m.