brapi_login: post /token

View source: R/brapi_login.R

brapi_loginR Documentation

post /token

Description

Login into a BrAPI compatible database.

Usage

brapi_login(con = NULL)

Arguments

con

list; required: TRUE; BrAPI connection object

Details

Although the POST /token call for authentication has been deprecated after version 1.1 of the BrAPI specification, its functionality is still retained for compatibility reasons with the Breeding Management System (BMS Pro) of Integrated Breeding Platform to allow users to obtain a valid token from within R and use with additional BrAPI R functions.

Value

A list object of class 'brapi_con' with the authentication token filled.

Author(s)

brapir generator package

References

BrAPI Specs GitHub

See Also

Other brapiutils: as.brapi_db(), brapi_canInternet(), brapi_checkCon(), brapi_connect(), brapi_db(), brapi_imagebreed_login(), brapi_imagebreed_logout(), brapi_serverinfo_show(), is.brapi_con(), print.brapi_con(), print.brapi_db()

Examples

## Not run: 

# Create a connection object
con <- brapi_db()$bms_test
# Add a username
con$user <- ""
# Add a password
con$password

# Login
con <-brapi_login(con = con)

## End(Not run)


mverouden/brapir documentation built on April 10, 2022, 5:36 p.m.