Update workspace connector policies in bulk

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Changes the policies of up to 100 connectors in a workspace at once.

A connector policy has two switches. builder_connection_enabled decides whether builders can connect the connector to the workspace's apps. per_user_connection_enabled decides whether the apps' users can connect their own accounts through a workspace connector. In FERPA-designated workspaces, OAuth connectors start with both switches off. Only an active workspace owner or admin can enable them; workspace credentials alone do not count as approval. Connector policies are available on every plan for those workspaces. Each action sets either switch, or both. Leave a switch out, or send null, to keep it.

Actions run in order, and each succeeds or fails on its own, so a 200 doesn't mean every action applied. Check ok on each result. A failed action changes nothing, except one that fails while saving: its first switch may already be saved, so read the policies again with Get workspace connector policies.

Turning a switch off also stops apps from using connections already made that way, until it's turned back on. Owners of affected apps get a notification.

Changing policies here needs a plan that includes connector policies, for every connector.

This is limited to 60 requests per minute, shared by Update builder connection policy, Update per-user connection policy, and Update workspace connector policies in bulk. A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit.

<Note>Call this as an owner or admin of the workspace, with a personal access token for that workspace sent as a Bearer token, or from a signed-in session. A read-only token is refused. Workspace API keys aren't accepted.</Note>

put/api/workspace/{workspace_id}/connector-governance/bulk

Request

  • Base URL: https://app.base44.com
  • URL: https://app.base44.com/api/workspace/{workspace_id}/connector-governance/bulk
  • Auth: HTTP bearer

Path parameters

workspace_idstring required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

Request body

Example request

{
  "actions": [
    {
      "builder_connection_enabled": false,
      "integration_type": "googlecalendar"
    },
    {
      "builder_connection_enabled": true,
      "integration_type": "slack",
      "per_user_connection_enabled": true
    }
  ]
}

Response

The outcome of each action.

Example response

{
  "results": [
    {
      "integration_type": "googlecalendar",
      "item": {
        "builder_connection_enabled": false,
        "connector_mode": "all",
        "display_name": "Google Calendar",
        "has_per_user_credentials": false,
        "integration_type": "googlecalendar",
        "not_yet_enabled": false,
        "per_user_connection_enabled": false
      },
      "ok": true
    },
    {
      "error": "Cannot enable per-user connections without credentials configured.",
      "integration_type": "slack",
      "ok": false
    }
  ]
}

Changes

    • info

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

    • info

      the endpoint scheme security PersonalAccessTokenAuth was added to the API