Skip to content

Credential function registry

Source: R/credential-function-registry.R
cred_funs.Rd

Functions to query or manipulate the registry of credential functions consulted by token_fetch().

Usage

cred_funs_list()

cred_funs_add(...)

cred_funs_set(ls)

cred_funs_clear()

cred_funs_set_default()

Arguments

...

One or more functions with the right signature: its first argument is named scopes, and it includes ... as an argument.

ls

A list of credential functions.

Value

A list of credential functions or NULL.

Functions

  • cred_funs_list(): Get the list of registered credential functions.

  • cred_funs_add(): Register one or more new credential fetching functions. Function(s) are added to the front of the list. So:

    * "First registered, last tried."
* "Last registered, first tried."

  • cred_funs_set(): Register a list of credential fetching functions.

  • cred_funs_clear(): Clear the credential function registry.

  • cred_funs_set_default(): Reset the registry to the gargle default.

See also

token_fetch(), which is where the registry is actually used.

Examples

names(cred_funs_list())
#> [1] "credentials_service_account"  "credentials_external_account"
#> [3] "credentials_app_default"      "credentials_gce"             
#> [5] "credentials_byo_oauth2"       "credentials_user_oauth2"     

creds_one <- function(scopes, ...) {}
cred_funs_add(creds_one)
cred_funs_add(one = creds_one)
cred_funs_add(one = creds_one, two = creds_one)
cred_funs_add(one = creds_one, creds_one)

# undo all of the above and return to default
cred_funs_set_default()