Title: Provides User Tokens for Access to ICES Web Services
Version: 1.1.4
Description: Provides user tokens for ICES web services that require authentication and authorization. Web services covered by this package are ICES VMS database, the ICES DATSU web services, and the ICES SharePoint site https://www.ices.dk/data/tools/Pages/WebServices.aspx.
Imports: httr, base64enc, jsonlite, askpass
License: GPL-3
Encoding: UTF-8
RoxygenNote: 7.3.2
URL: https://www.ices.dk/data/tools/Pages/WebServices.aspx, https://github.com/ices-tools-prod/icesConnect
BugReports: https://github.com/ices-tools-prod/icesConnect/issues
Language: en-GB
NeedsCompilation: no
Packaged: 2025-04-30 17:11:21 UTC; colin
Author: Colin Millar [aut, cre]
Maintainer: Colin Millar <colin.millar@ices.dk>
Repository: CRAN
Date/Publication: 2025-04-30 17:30:01 UTC

clear_token

Description

Deletes the token from the key ring.

Usage

clear_token(username = get_username())

Arguments

username

the ices username that you require a token for, Default: getOption("ices.username")

Value

no return value

Examples

## Not run: 
clear_token()

## End(Not run)

get_username

Description

Get your ICES username from the options.

Set the ICES user or logon name that will be used for requests

Usage

clear_username()

get_username()

set_username(username)

Arguments

username

the ices username you use to login to SharePoint for example.

Value

character scalar, the username

invisible value: the previous username that was set

Examples

## Not run: 
get_username()

## End(Not run)

## Not run: 
set_username("myusername")

## End(Not run)

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

jwt

a javascript web token got by running ices_token()

formatted

should formatted output be returned

Value

list of claims

POSIXct date time

string, user name

See Also

username

username

username

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
)

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

ices_patch_jwt(
  url,
  body = list(),
  encode = "json",
  username = NULL,
  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",
  username = NULL,
  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"),
  username = NULL,
  retry = TRUE,
  quiet = FALSE,
  verbose = FALSE,
  jwt = NULL
)

Arguments

url

the url to make the request to

retry

if initial request fails, should a retry be made, Default: TRUE

quiet

suppress informative messages to the console

verbose

should the http request return verbose output

content

logical, if TRUE the content of the response is returned, if FALSE the http response object is returned

use_token

logical, if TRUE the token is used, if FALSE the token is not used

username

the ices username to perform the request as, Default: getOption("ices.username")

jwt

option to supply a token bypassing the ices_token() route, if "" no token is used

body

optional body of request

encode

If the body is a named list, how should it be encoded?

type

the type of request to make, GET, POST or PATCH

Value

http response object

See Also

ices_token GET,add_headers,stop_for_status,status_code

Examples

## Not run: 
# this function is interactive and asks the user for a password
ices_request_jwt("GET", "https://taf.ices.dk/vms/api/gearwidths")
ices_get_jwt("https://taf.ices.dk/vms/api/gearwidths")

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

## End(Not run)

ices_token

Description

Stores a user token in the system keyring

Usage

ices_token(username = NULL, password = NULL, refresh = FALSE, ...)

Arguments

username

the ices username that you require a token for, Default: NULL, which results in getOption("ices.username")

password

the ices username that you require a token for, Default: NULL, which results in a dialogue box request for the password

refresh

should the token be refreshed to update new claims for example

...

not yet used

Value

character scalar, the token

Examples

## Not run: 
ices_token()

## End(Not run)