Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/customer-guides/update-connection.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Update a connection"
description: "Reauthenticate a SaaS connection from the Manage tab in the UI component, or change installation objects, fields, and mappings without disconnecting."
---

If the credentials you provided for an integration need to be updated, you can use the **Manage** tab in the UI component to update your connection.
Expand All @@ -20,6 +21,13 @@ Re-authentication for the connection may be required in the following scenarios:

2. Under the **Update connection** section enter credentials as needed and click the **Next** button.

## Update the integration configuration

You can change what an integration reads or writes without disconnecting. The connection (credentials) and the installation configuration (objects, fields, mappings, schedule) are stored separately, so updating the configuration keeps the existing connection in place.

- **In the UI component**: open the **Manage** tab and edit the objects, fields, or mappings you want to change. The [InstallIntegration](/embeddable-ui-components#install-integration) component displays the current configuration when an installation already exists for the [group](/terminology#group), so end users can update it in place.
- **Via API**: call [Update an installation](/reference/installation/update-an-installation) to replace the full installation config, or [Update an installation object](/reference/installation/update-an-installation-object) to patch a single object's config (fields, schedule, filters). Neither endpoint touches the underlying connection.

## If Manage tab isn't visible

If you do not see the **Manage** tab, it means that the app builder needs to update `@amp-labs/react` to v2.7+ in their code.
3 changes: 3 additions & 0 deletions src/embeddable-ui-components.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Prebuilt UI components"
description: "Drop InstallIntegration, ConnectProvider, and related React components into your app so end users can connect and configure SaaS integrations."
---

## Project setup
Expand Down Expand Up @@ -173,6 +174,8 @@ To activate wizard mode, pass `variant="wizard"` to the `InstallIntegration` com

When no installation exists, the wizard renders. If an installation already exists, the standard configuration UI is shown instead.

If the object-selection step shows **"No objects available for this integration"**, the integration in the currently deployed `amp.yaml` has no objects defined under `read.objects` or `write.objects`. Add the objects you want end users to configure, then redeploy with the [amp CLI](/cli/overview). Also confirm you are pointing the component at the same project the manifest was deployed to. See [Read objects](/read-actions) and [Write objects](/write-actions) for the required manifest format.

| Feature | Supported |
|---|---|
| [Read objects](/read-actions) | Yes |
Expand Down
Loading