integration#
Manage OAuth integrations on Posit Connect.
Usage:
integration [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
integration add#
Create a new OAuth integration.
Usage:
integration add [OPTIONS]
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
-t, --template TEXT The template key (e.g. 'custom').
[required]
-N, --integration-name TEXT A display name for the integration.
-d, --description TEXT A description for the integration.
-C, --config KEY=VALUE A config field as key=value. Repeat for
multiple fields.
--allow-user STRIPPEDSTRING A user GUID to grant access.
--allow-group STRIPPEDSTRING A group GUID to grant access.
--help Show this message and exit.
integration edit#
Update an existing OAuth integration.
Usage:
integration edit [OPTIONS]
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
-g, --guid STRIPPEDSTRING The GUID of the integration. [required]
-N, --integration-name TEXT A new display name for the integration.
-d, --description TEXT A new description for the integration.
-C, --config KEY=VALUE A config field as key=value. Merges with
existing config. Repeat for multiple fields.
--allow-user STRIPPEDSTRING A user GUID to grant access.
--allow-group STRIPPEDSTRING A group GUID to grant access.
--help Show this message and exit.
integration list#
List OAuth integrations.
Usage:
integration list [OPTIONS]
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
--help Show this message and exit.
integration remove#
Delete an OAuth integration.
Usage:
integration remove [OPTIONS]
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
-g, --guid STRIPPEDSTRING The GUID of the integration. [required]
--help Show this message and exit.
integration show#
Show a single OAuth integration.
Usage:
integration show [OPTIONS]
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
-g, --guid STRIPPEDSTRING The GUID of the integration. [required]
--help Show this message and exit.
integration templates#
List and inspect OAuth integration templates.
Usage:
integration templates [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
integration templates list#
List available OAuth templates.
Usage:
integration templates list [OPTIONS]
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
--help Show this message and exit.
integration templates show#
Show details of an OAuth template.
Usage:
integration templates show [OPTIONS]
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
--key STRIPPEDSTRING The template key. [required]
--help Show this message and exit.
