vault_api_client: Vault Low-Level Client
In vaultr: Vault Client for Secrets and Sensitive Data
vault_api_client R Documentation
Vault Low-Level Client
Description
Vault Low-Level Client
Vault Low-Level Client
Details
Low-level API client. This can be used to directly communicate
with the vault server. This object will primarily be useful for
debugging, testing or developing new vault methods, but is
nonetheless described here.
Super class
vaultr::vault_client_object -> vault_api_client
Public fields
addrThe vault address (with protocol, hostname and port)
base_urlThe base url (with protocol, hostname, port and
api version path)
tls_configInformation used in TLS config, if used
namespaceThe vault namespace, if used
tokenThe vault token, if authenticated
versionThe vault server version, once queried
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
Inherited methods
Method new()
Create a new api client
Usage
vault_api_client$new(addr = NULL, tls_config = NULL, namespace = NULL)
Arguments
addrAddress of the vault server
tls_configOptional TLS config
namespaceOptional namespace
Method request()
Make a request to the api. Typically you should use
one of the higher-level wrappers, such as $GET or $POST.
Usage
vault_api_client$request(verb, path, ..., token = self$token)
Arguments
verbThe HTTP verb to use, as a httr function (e.g.,
pass httr::GET for a GET request).
pathThe request path
...Additional arguments passed to the httr function
tokenOptional token, overriding the client token
Method is_authenticated()
Test if the vault client currently holds a vault token.
This method does not verify the token - only test that is present.
Usage
vault_api_client$is_authenticated()
Method set_token()
Set a token within the client
Usage
vault_api_client$set_token(token, verify = FALSE, quiet = FALSE)
Arguments
tokenString, with the new vault client token
verifyLogical, indicating if we should test that the token
is valid. If TRUE, then we use $verify_token() to test the
token before setting it and if it is not valid an error will be
thrown and the token not set.
quietLogical, if TRUE, then informational messages will be
suppressed.
Method verify_token()
Test that a token is valid with the vault.
This will call vault's /sys/capabilities-self endpoint with the
token provided and check the /sys path.
Usage
vault_api_client$verify_token(token, quiet = TRUE)
Arguments
tokenString, with the vault client token to test
quietLogical, if TRUE, then informational messages will be
suppressed
Method server_version()
Retrieve the vault server version. This is by default
cached within the client for a session. Will return an R
numeric_version object.
Usage
vault_api_client$server_version(refresh = FALSE)
Arguments
refreshLogical, indicating if the server version information
should be refreshed even if known.
Method GET()
Send a GET request to the vault server
Usage
vault_api_client$GET(path, ...)
Arguments
pathThe server path to use. This is the "interesting"
part of the path only, with the server base url and api version
information added.
...Additional httr-compatible options. These will be named
parameters or httr "request" objects.
Method LIST()
Send a LIST request to the vault server
Usage
vault_api_client$LIST(path, ...)
Arguments
pathThe server path to use. This is the "interesting"
part of the path only, with the server base url and api version
information added.
...Additional httr-compatible options. These will be named
parameters or httr "request" objects.
Method POST()
Send a POST request to the vault server
Usage
vault_api_client$POST(path, ...)
Arguments
pathThe server path to use. This is the "interesting"
part of the path only, with the server base url and api version
information added.
...Additional httr-compatible options. These will be named
parameters or httr "request" objects.
Method PUT()
Send a PUT request to the vault server
Usage
vault_api_client$PUT(path, ...)
Arguments
pathThe server path to use. This is the "interesting"
part of the path only, with the server base url and api version
information added.
...Additional httr-compatible options. These will be named
parameters or httr "request" objects.
Method DELETE()
Send a DELETE request to the vault server
Usage
vault_api_client$DELETE(path, ...)
Arguments
pathThe server path to use. This is the "interesting"
part of the path only, with the server base url and api version
information added.
...Additional httr-compatible options. These will be named
parameters or httr "request" objects.
Examples
server <- vaultr::vault_test_server(if_disabled = message)
if (!is.null(server)) {
# Ordinarily, we would use the "vault_client" object for
# high-level access to the vault server
client <- server$client()
client$status()
# The api() method returns the "api client" object:
api <- client$api()
api
# This allows running arbitrary HTTP requests against the server:
api$GET("/sys/seal-status")
# this is how vaultr is internally implemented so anything can
# be done here, for example following vault's API documentation
# https://www.vaultproject.io/api/secret/kv/kv-v1.html#sample-request-2
api$POST("/secret/mysecret", body = list(key = "value"))
api$GET("/secret/mysecret")
api$DELETE("/secret/mysecret")
# cleanup
server$kill()
}
vaultr documentation built on Nov. 9, 2023, 5:07 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| vault_api_client | R Documentation |
Vault Low-Level Client
Description
Vault Low-Level Client
Vault Low-Level Client
Details
Low-level API client. This can be used to directly communicate with the vault server. This object will primarily be useful for debugging, testing or developing new vault methods, but is nonetheless described here.
Super class
vaultr::vault_client_object -> vault_api_client
Public fields
addrThe vault address (with protocol, hostname and port)
base_urlThe base url (with protocol, hostname, port and api version path)
tls_configInformation used in TLS config, if used
namespaceThe vault namespace, if used
tokenThe vault token, if authenticated
versionThe vault server version, once queried
Methods
Public methods
Inherited methods
Method new()
Create a new api client
Usage
vault_api_client$new(addr = NULL, tls_config = NULL, namespace = NULL)
Arguments
addrAddress of the vault server
tls_configOptional TLS config
namespaceOptional namespace
Method request()
Make a request to the api. Typically you should use
one of the higher-level wrappers, such as $GET or $POST.
Usage
vault_api_client$request(verb, path, ..., token = self$token)
Arguments
verbThe HTTP verb to use, as a
httrfunction (e.g., passhttr::GETfor aGETrequest).pathThe request path
...Additional arguments passed to the
httrfunctiontokenOptional token, overriding the client token
Method is_authenticated()
Test if the vault client currently holds a vault token. This method does not verify the token - only test that is present.
Usage
vault_api_client$is_authenticated()
Method set_token()
Set a token within the client
Usage
vault_api_client$set_token(token, verify = FALSE, quiet = FALSE)
Arguments
tokenString, with the new vault client token
verifyLogical, indicating if we should test that the token is valid. If
TRUE, then we use$verify_token()to test the token before setting it and if it is not valid an error will be thrown and the token not set.quietLogical, if
TRUE, then informational messages will be suppressed.
Method verify_token()
Test that a token is valid with the vault.
This will call vault's /sys/capabilities-self endpoint with the
token provided and check the /sys path.
Usage
vault_api_client$verify_token(token, quiet = TRUE)
Arguments
tokenString, with the vault client token to test
quietLogical, if
TRUE, then informational messages will be suppressed
Method server_version()
Retrieve the vault server version. This is by default cached within the client for a session. Will return an R numeric_version object.
Usage
vault_api_client$server_version(refresh = FALSE)
Arguments
refreshLogical, indicating if the server version information should be refreshed even if known.
Method GET()
Send a GET request to the vault server
Usage
vault_api_client$GET(path, ...)
Arguments
pathThe server path to use. This is the "interesting" part of the path only, with the server base url and api version information added.
...Additional
httr-compatible options. These will be named parameters orhttr"request" objects.
Method LIST()
Send a LIST request to the vault server
Usage
vault_api_client$LIST(path, ...)
Arguments
pathThe server path to use. This is the "interesting" part of the path only, with the server base url and api version information added.
...Additional
httr-compatible options. These will be named parameters orhttr"request" objects.
Method POST()
Send a POST request to the vault server
Usage
vault_api_client$POST(path, ...)
Arguments
pathThe server path to use. This is the "interesting" part of the path only, with the server base url and api version information added.
...Additional
httr-compatible options. These will be named parameters orhttr"request" objects.
Method PUT()
Send a PUT request to the vault server
Usage
vault_api_client$PUT(path, ...)
Arguments
pathThe server path to use. This is the "interesting" part of the path only, with the server base url and api version information added.
...Additional
httr-compatible options. These will be named parameters orhttr"request" objects.
Method DELETE()
Send a DELETE request to the vault server
Usage
vault_api_client$DELETE(path, ...)
Arguments
pathThe server path to use. This is the "interesting" part of the path only, with the server base url and api version information added.
...Additional
httr-compatible options. These will be named parameters orhttr"request" objects.
Examples
server <- vaultr::vault_test_server(if_disabled = message)
if (!is.null(server)) {
# Ordinarily, we would use the "vault_client" object for
# high-level access to the vault server
client <- server$client()
client$status()
# The api() method returns the "api client" object:
api <- client$api()
api
# This allows running arbitrary HTTP requests against the server:
api$GET("/sys/seal-status")
# this is how vaultr is internally implemented so anything can
# be done here, for example following vault's API documentation
# https://www.vaultproject.io/api/secret/kv/kv-v1.html#sample-request-2
api$POST("/secret/mysecret", body = list(key = "value"))
api$GET("/secret/mysecret")
api$DELETE("/secret/mysecret")
# cleanup
server$kill()
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.