CredentialApi: Credential operations

In BIDMCDigitalPsychiatry/LAMP-r: API Client for LAMP Platform

Description

LAMP.Credential

Format

An R6Class generator object

Methods

create

• @param type.id character

• @param body object

• status code : 200 | 200 Success

• return type : object

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

delete

• @param type.id character

• @param access.key character

• status code : 200 | 200 Success

• return type : object

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

list

• @param type.id character

• @param transform character

• status code : 200 | 200 Success

• return type : object

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

update

• @param type.id character

• @param access.key character

• @param body object

• status code : 200 | 200 Success

• return type : object

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• CredentialApi$new()

• CredentialApi$create()

• CredentialApi$createWithHttpInfo()

• CredentialApi$delete()

• CredentialApi$deleteWithHttpInfo()

• CredentialApi$list()

• CredentialApi$listWithHttpInfo()

• CredentialApi$update()

• CredentialApi$updateWithHttpInfo()

• CredentialApi$clone()

---

Method new()

Usage

CredentialApi$new(apiClient)

---

Method create()

Usage

CredentialApi$create(type.id, body, ...)

---

Method createWithHttpInfo()

Usage

CredentialApi$createWithHttpInfo(type.id, body, ...)

---

Method delete()

Usage

CredentialApi$delete(type.id, access.key, ...)

---

Method deleteWithHttpInfo()

Usage

CredentialApi$deleteWithHttpInfo(type.id, access.key, ...)

---

Method list()

Usage

CredentialApi$list(type.id, transform = NULL, ...)

---

Method listWithHttpInfo()

Usage

CredentialApi$listWithHttpInfo(type.id, transform = NULL, ...)

---

Method update()

Usage

CredentialApi$update(type.id, access.key, body, ...)

---

Method updateWithHttpInfo()

Usage

CredentialApi$updateWithHttpInfo(type.id, access.key, body, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CredentialApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  create  ####################

library(LAMP)
var.type.id <- 'type.id_example' # character | 
var.body <- NULL # object | 

result <- LAMP.Credential$create(var.type.id, var.body)


####################  delete  ####################

library(LAMP)
var.type.id <- 'type.id_example' # character | 
var.access.key <- 'access.key_example' # character | 

result <- LAMP.Credential$delete(var.type.id, var.access.key)


####################  list  ####################

library(LAMP)
var.type.id <- 'type.id_example' # character | 

result <- LAMP.Credential$list(var.type.id)


####################  update  ####################

library(LAMP)
var.type.id <- 'type.id_example' # character | 
var.access.key <- 'access.key_example' # character | 
var.body <- NULL # object | 

result <- LAMP.Credential$update(var.type.id, var.access.key, var.body)



## End(Not run)

BIDMCDigitalPsychiatry/LAMP-r documentation built on April 29, 2020, 9:51 a.m.