Connector Configuration

Update connector configuration

Changed on

Update authentication, sync, and filter configuration.<br><br> <b>Prerequisites:</b><br> Connector must be <b>disabled</b> before updating configuration. Disable it first using <code>POST /{id}/toggle</code>.<br><br> <b>Partial Updates:</b><br> Only provide the sections you want to update. Omitted sections are not modified.<br><br> <b>Secrets:</b><br> A secret field in <code>auth</code> sent as <code>••••••••</code> keeps the stored value, so the configuration can be sent back as it was read. The response masks stored secrets the same way.<br><br> <b>Signing out:</b><br> A change to <code>auth</code>, a different top-level <code>oauthConfigId</code>, or a linked OAuth app that now holds a different client signs the connector out and clears its OAuth tokens. Sending <code>auth</code> back as it was read, with secrets as the mask or in full, keeps it signed in.<br><br> <b>OAuth apps (OAUTH connectors):</b><br> An OAUTH connector signs in with the client ID and secret of its linked OAuth app, so client credentials an admin sends in <code>auth</code> go into an app, as on <code>PUT /{connectorId}/config/auth</code>:

<ul> <li>On a connector with no app, an app is created from them and linked (<code>auth.oauthConfigId</code> in the response) once every required OAuth field is present; until then the values are kept on the connector.</li> <li>On a linked connector, changed values update the app named in <code>auth.oauthConfigId</code>, and only the fields that changed. Without that field a new app is created and linked; the previously linked app, which other connectors may share, is not changed.</li> <li>The new app is named <code>auth.oauthInstanceName</code>, or else after the connector.</li> </ul> A linked connector stores no copy of its app's secret fields: they are not stored, and not returned, in <code>config.auth</code>. Its client ID and provider URLs are the app's. Only an admin's credentials create or change an app.
put/connectors/{connectorId}/config

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/connectors/{connectorId}/config
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: connector:write, connector:read

Path parameters

connectorIdstring required

Request body

baseUrlstring

Base URL for self-hosted instances. Any string is accepted; it is not checked to be a URL.

Example request

{
  "auth": {
    "baseUrl": "https://mycompany.atlassian.net",
    "email": "admin@mycompany.com",
    "apiToken": "ATATT3x..."
  },
  "baseUrl": "https://confluence.mycompany.com"
}

Response

Configuration updated

successboolean required
messagestring

Example response

{
  "config": {
    "auth": {
      "connectorScope": "team"
    }
  },
  "message": "Configuration saved successfully."
}

Changes

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property //

    • info

      the request property format was generalized from uri to no format

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • warning

      added the new ENTRA_ID enum value to the // response property for the response status

    • warning

      added the new IAM_ROLE enum value to the // response property for the response status