update_integration: Update an OAuth integration

In connectapi: Utilities for Interacting with the 'Posit Connect' Server API

Update an OAuth integration

Description

Updates an existing OAuth integration. All fields except integration are optional, and are unchanged if not provided.

You must have administrator privileges to perform this action.

See the Posit Connect documentation on OAuth integrations for more information.

Usage

update_integration(
  integration,
  name = NULL,
  description = NULL,
  template = NULL,
  config = NULL
)

Arguments

integration	A connect_integration object (as returned by get_integrations(), get_integration(), or create_integration()).
name	A new name for the integration.
description	A new description for the integration.
template	The template to use (generally not changed after creation).
config	A list with updated OAuth integration configuration. If NULL (default), the configuration remains unchanged. You can update individual configuration fields without affecting others.

Value

A connect_integration object representing the updated OAuth integration. See get_integration() for details on the returned object.

See Also

get_integrations(), get_integration(), create_integration(), delete_integration()

Other oauth integration functions: create_integration(), delete_integration(), get_associations(), get_integration(), get_integrations(), set_integrations()

Examples

## Not run: 
client <- connect()

# Get an existing integration
integration <- get_integration(client, "your-integration-guid")

# Update the integration's name and description
updated_integration <- update_integration(
  integration,
  name = "Updated GitHub Integration",
  description = "A more descriptive description."
)

# Update only the client secret in the configuration
updated_integration <- update_integration(
  integration,
  config = list(
    client_secret = "your-new-client-secret"
  )
)

## End(Not run)

connectapi documentation built on Nov. 5, 2025, 7:32 p.m.