Update an Integration

Suggest Edits

Update an existing custom Integration by ID. Every update request must include the application authentication parameters.

Method Signature

Integration update(String id, String name, IntegrationConfiguration oauthConfig);

Parameters

Parameter	Type	Description
`id`	`String`	The id of the Integration to update
`name`	`String`	The display name to apply to the Integration
`oauthConfig`	`IntegrationConfiguration`	The configuration settings for the Integration
returns	`Integration`	The updated Integration

`IntegrationConfiguration`

Name	Type	Description
`clientId`	`String`	Client ID of the OAuth Application
`clientSecret`	`String`	Client Secret of the OAuth Application
`tokenPath`	`String`	Token Path of the OAuth Application
`revokePath`	`String`	Token Revocation Path of the OAuth Application
`authorizeBaseUrl`	`String`	The base URL of the OAuth Application
`site`	`String`	The website of the OAuth Application
`scopes`	`List<String>`	The list of Scopes to apply to Connections using the Integration
`useBodyAuth`	`Boolean`	Boolean indicating whether auth params should be sent to OAuth app in body

Example

/*
 * This example demonstrates updating an existing custom Integration
 */

import org.catalytic.sdk.CatalyticClient;
import org.catalytic.sdk.entities.Integration;
import org.catalytic.sdk.entities.IntegrationConfiguration;

public class Program {
  
    public static void main(String[] args) throws Exception {
      	
      	// Create and initialize the Catalytic SDK Client
    	CatalyticClient catalytic = new CatalyticClient();
        
        IntegrationConfiguration oauthConfig = new IntegrationConfiguration(
            "myOauthId",
            "myOauthSecret",
            "/token",
            "/revoke",
            new URI("https://example.com/"),
            new URI("https://example.com/oauth"),
            Arrays.asList("read", "write")
        );

      	// Update the Integration with id "my-example-integration"
      	Integration integration = catalytic.integrations().update("my-example-integration", oauthConfig);
        
        System.out.println("Update integration name: " + integration.getName());
    }
}

Updated over 3 years ago