v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB

AuthConnector

Update a connector

Update a connector (superadmin only).

patch/auth/connectors/{connector_id}

Path parameters

connector_idinteger required

ID of the connector to update.

Query parameters

cookie_namestring nullable

Request body

descriptionstring nullable

New description for the connector.

Example request

{
  "description": "Access OneDrive files for retrieval."
}

Response

Successful Response

created_atstring date-time

UTC timestamp when the record was created.

updated_atstring date-time

UTC timestamp when the record was last updated.

creator_user_idinteger nullable

ID of the user who created the record, if attributable.

updater_user_idinteger nullable

ID of the user who last updated the record, if any.

idinteger nullable

Primary key for the connector.

oauth_client_idinteger required

ID of the OAuth client backing this connector.

namestring required

Name of the connector.

descriptionstring nullable

Optional description of the connector.

scopesstring[]

OAuth scopes requested by this connector.

capsstring[]

Capabilities provided by this connector.

auto_attachboolean

Whether this connector is automatically attached to new resources.

Example response

{
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-16T08:00:00Z",
  "creator_user_id": 12,
  "updater_user_id": 12,
  "id": 1,
  "oauth_client_id": 1,
  "name": "SharePoint",
  "description": "Connects to SharePoint document libraries",
  "scopes": [
    "Files.Read.All",
    "Sites.Read.All"
  ],
  "caps": [
    "read_files",
    "list_sites"
  ]
}