PIpipeshub-ai
Connector Configuration

Update authentication configuration

Changed on

Update only the authentication configuration.<br><br> <b>Use Case:</b><br> Use this when you need to update credentials without changing sync or filter settings. Useful for credential rotation.<br><br> <b>Prerequisites:</b><br> Connector must be disabled. This endpoint clears OAuth state, requiring re-authentication for OAuth connectors.<br><br> <b>Secrets:</b><br> A secret field sent as <code>••••••••</code> keeps the stored value; send a new value to replace it. The response masks stored secrets the same way.

put/connectors/{connectorId}/config/auth

Request

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

Path parameters

connectorIdstring required

Connector instance ID

Request body

baseUrlstring

Recomputes the OAuth redirect URI

Example request

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

Response

Auth settings saved. The connector is signed out and turned off.

successboolean required
messagestring

Example response

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

Changes

  • dbb5e203b445Revision changes
    • 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

  • fc76aa045994Revision changes
    • 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