AppAuth-class: 'AppAuth' class

In BaseSpaceR: R SDK for BaseSpace RESTful API

Description

Class to manage client's communication and permissions with BaseSpace REST serve.

Methods

initializeAuth

signature(x = "AppAuth"): ...

requestAccessToken

signature(x = "AppAuth"): ...

hasAccess

signature(x = "AppAuth"): ...

Author(s)

Adrian Alexa

References

https://developer.basespace.illumina.com/docs/content/documentation/rest-api/api-reference

See Also

Runs, Projects, Samples, etc. for examples of objects using the AppAuth handler.

ServiceURI for a low-level object managing the REST calls.

Examples

showClass("AppAuth")

## load an AppAuth instance containing a pre-generated access token
data(aAuth)
aAuth

hasAccess(aAuth)

## new AppAuth instance using a pre-generated access token
my_access_token <- "eee44c28ba0e43a1badb85c5ce7bb94d"
myHandle <- AppAuth(access_token = my_access_token)
myHandle

Users(myHandle)


## using the OAuth v2 workflow 
## Not run: 
## paste your client_id and client_secret here
myAppClientId = ""
myAppClientSecret = ""

## instantiate a new AppAuth object
myHandle <- AppAuth(client_id = myAppClientId,
                    client_secret = myAppClientSecret,
                    scope = "browse global")

## Open the showed URI in a browser and perform the authentication.

requestAccessToken(myHandle)
hasAccess(myHandle)


## End(Not run)

BaseSpaceR documentation built on Nov. 8, 2020, 5:12 p.m.