Package {icesConnect}

Decode token

Description

Decodes the token to allow inspection of claims

Return the expiration date of the token

What user is this token for

Usage

decode_token(jwt = ices_token(), formatted = TRUE)

token_expiration(jwt = ices_token())

token_user(jwt = ices_token())

Arguments

Value

list of claims, or an empty list if the token is empty or can not be decoded

POSIXct date time

string, user

Examples

## Not run: 
decode_token()

## End(Not run)

## Not run: 
token_expiration()

## End(Not run)

## Not run: 
token_user()

## End(Not run)

ices_request_jwt

Description

Perform a get request to a url using a javascript web token for authentication

Usage

ices_get(
  url,
  retry = TRUE,
  quiet = FALSE,
  verbose = FALSE,
  content = TRUE,
  use_token = FALSE,
  jwt = NULL
)

ices_get_jwt(url, retry = TRUE, quiet = FALSE, verbose = FALSE, jwt = NULL)

ices_patch_jwt(
  url,
  body = list(),
  encode = "json",
  retry = TRUE,
  quiet = FALSE,
  verbose = FALSE,
  jwt = NULL
)

ices_post(
  url,
  body = list(),
  retry = TRUE,
  verbose = FALSE,
  content = TRUE,
  use_token = TRUE,
  encode = "multipart"
)

ices_post_jwt(
  url,
  body = list(),
  encode = "json",
  retry = TRUE,
  quiet = FALSE,
  verbose = FALSE,
  jwt = NULL
)

ices_request_jwt(
  type = c("GET", "POST", "PATCH"),
  url,
  body = NULL,
  encode = c("multipart", "form", "json", "raw"),
  retry = TRUE,
  quiet = FALSE,
  verbose = FALSE,
  jwt = NULL
)

Arguments

Value

http response object, or NULL if the request could not be made, for example if there is no internet connection or the token is not valid. For ices_get() and ices_post() with content = TRUE, the parsed content of the response, or NULL if the request was not successful.

See Also

ices_token, set_token GET,add_headers,stop_for_status,status_code

Examples

## Not run: 
# requests using a token, set the token first using set_token()
ices_request_jwt("GET", "https://data.ices.dk/vms/api/gearwidths")
ices_get_jwt("https://data.ices.dk/vms/api/gearwidths")

# the top level function
ices_get("https://data.ices.dk/vms/api/gearwidths", content = FALSE, use_token = TRUE)
ices_get("https://data.ices.dk/vms/api/gearwidths", content = TRUE)

## End(Not run)

ices_token

Description

Returns the user token stored by set_token(), if it is present and has not expired.

Usage

ices_token(...)

Arguments

Details

Tokens are created at https://data.ices.dk/token. Log in, then copy the R code shown on the page into your R session to store the token. Tokens can not be refreshed from R: when a token expires, get a new one from the same page.

Value

character scalar, the token, or "" if there is no valid token

See Also

set_token() to store a token.

Examples

## Not run: 
ices_token()

## End(Not run)

Set your ICES token

Description

Stores a user token for use in requests to ICES web services that require authentication.

Usage

set_token(token)

Arguments

Details

Tokens are created at https://data.ices.dk/token. Log in, then copy the R code shown on the page into your R session. Tokens can not be refreshed from R: when a token expires, get a new one from the same page.

The token is stored in the user configuration directory given by tools::R_user_dir("icesConnect", "config"), replacing any token stored previously.

Value

invisible logical, TRUE if the token was stored

See Also

ices_token() to get the stored token, and decode_token() to see who the token is for and when it expires.

Examples

## Not run: 
set_token("<token copied from https://data.ices.dk/token>")

## End(Not run)

Set your ICES username

Description

Back compatability function that does nothing. A username is no longer needed: tokens are created at https://data.ices.dk/token and stored using set_token().

Usage

set_username(...)

Arguments

Value

invisible NULL