docs/NIHApi.md

In vjcitn/terraClientR: R Package Client for FireCloud

NIHApi

All URIs are relative to http://localhost

Method | HTTP request | Description ------------- | ------------- | ------------- NIHCallback | POST /api/nih/callback | Updates a user's NIH link from a JWT NIHStatus | GET /api/nih/status | Retrieves info about a user's NIH link

NIHCallback

NihStatus NIHCallback(jwt)

Updates a user's NIH link from a JWT

Example

library(openapi)

var.jwt <- JWTWrapper$new("jwt_example") # JWTWrapper | JWT from NIH login

#Updates a user's NIH link from a JWT
api.instance <- NIHApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
result <- api.instance$NIHCallback(var.jwt)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- jwt | JWTWrapper| JWT from NIH login |

Return type

NihStatus

Authorization

googleoauth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Successfully updated NIH link | - | | 400 | Invalid or malformed JWT | - | | 401 | Unauthorized | - | | 500 | Internal server error saving NIH link to profile | - |

NIHStatus

NihStatus NIHStatus()

Retrieves info about a user's NIH link

Example

library(openapi)


#Retrieves info about a user's NIH link
api.instance <- NIHApi$new()
# Configure OAuth2 access token for authorization: googleoauth
api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
result <- api.instance$NIHStatus()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

NihStatus

Authorization

googleoauth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Successfully retrieved NIH status | - | | 404 | linkedNihUsername key missing from status | - | | 500 | Internal server error retrieving NIH status | - |

vjcitn/terraClientR documentation built on Dec. 23, 2021, 4:07 p.m.