Package index

Authentication

Log in, log out, and manage auth state.

auth_login()

Smart authentication for SpeedGoat APIs

auth_logout()

Log user out of system

auth_me()

Return information about the logged in (current) user

auth_status()

Print authentication status

auth_switch_project()

Switch to a different project

auth_validate()

Validate a token against the API

auth_use_token()

Use an existing token for API calls

is_auth()

Check if a user is authenticated

swagger_login()

Login for Swagger documentation

Deprecated

These functions still work but emit a deprecation warning.

auth_check() deprecated

Check a token's validity

auth_forward_token() deprecated

Forward an authenticated token for internal API calls

auth_url() deprecated

Set authentication URL

set_api_key() deprecated

Set API key in system keyring

User and project identity

Retrieve the authenticated user’s identity.

user_id()

Get the user's unique identifier

project_id()

Get user's project ID

API registration

Register API endpoints and manage realms.

add_api()

Add an API endpoint to authentication state

APIAuthState

API authorization state

init_APIAuthState()

Create an APIAuthState

Request building

Build and execute API requests.

api_get() api_get_id()

A generic helper for creating GET requests to the API

api_post() api_post_multi() api_post_df() api_post_progress() api_post_file()

A generic helper for creating POST requests to the API

api_patch() api_patch_multi()

Create a PATCH request

api_delete()

Delete a record in the database

api_export()

Create a call to an export endpoint

api_perform()

Perform a request to an API endpoint

Response parsing

Parse API responses into R objects.

parse_parquet2df() parse_url2df() parse_url() parse_json2list() parse_json2tibble() parse_multi2tibble()

Parse a response into a more useful form

Utilities

check_enum()

Validate values against an allowed set

check_required_cols()

Check that a data frame contains required columns

compact_list()

Remove NULL elements from a list

format_timestamp()

Format a timestamp for the API

spdgt_select()

Select columns from a parsed API response

spdgt.auth spdgt.auth-package

spdgt.auth: Authentication for SPDGT APIs