---
title: "POST /v1/global-connections"
method: POST
path: "/v1/global-connections"
tags: ["global-connections"]
---

# POST /v1/global-connections

`POST /v1/global-connections`

## Request body

- union
  - object
    - `displayName` string, required
    - `pieceName` string, required
    - `metadata` object
    - `pieceVersion` string
    - `type` 'SECRET_TEXT', required
    - `value` object, required
      - `type` 'SECRET_TEXT', required
      - `secret_text` string, required
    - `scope` 'PLATFORM', required
    - `projectIds` string[], required
    - `externalId` string
    - `preSelectForNewProjects` boolean
  - object
    - `displayName` string, required
    - `pieceName` string, required
    - `metadata` object
    - `pieceVersion` string
    - `type` 'OAUTH2', required
    - `value` object, required
      - `client_id` string, required
      - `code` string, required
      - `code_challenge` string
      - `scope` string, required
      - `authorization_method` 'HEADER' | 'BODY'
      - `client_secret` string, required
      - `grant_type` 'authorization_code' | 'client_credentials'
      - `props` object
      - `redirect_url` string, required
      - `type` 'OAUTH2', required
    - `scope` 'PLATFORM', required
    - `projectIds` string[], required
    - `externalId` string
    - `preSelectForNewProjects` boolean
  - object
    - `displayName` string, required
    - `pieceName` string, required
    - `metadata` object
    - `pieceVersion` string
    - `type` 'CLOUD_OAUTH2', required
    - `value` object, required
      - `client_id` string, required
      - `code` string, required
      - `code_challenge` string
      - `scope` string, required
      - `authorization_method` 'HEADER' | 'BODY'
      - `props` object
      - `type` 'CLOUD_OAUTH2', required
    - `scope` 'PLATFORM', required
    - `projectIds` string[], required
    - `externalId` string
    - `preSelectForNewProjects` boolean
  - object
    - `displayName` string, required
    - `pieceName` string, required
    - `metadata` object
    - `pieceVersion` string
    - `type` 'PLATFORM_OAUTH2', required
    - `value` object, required
      - `client_id` string, required
      - `code` string, required
      - `code_challenge` string
      - `scope` string, required
      - `authorization_method` 'HEADER' | 'BODY'
      - `props` object
      - `type` 'PLATFORM_OAUTH2', required
      - `redirect_url` string, required
    - `scope` 'PLATFORM', required
    - `projectIds` string[], required
    - `externalId` string
    - `preSelectForNewProjects` boolean
  - object
    - `displayName` string, required
    - `pieceName` string, required
    - `metadata` object
    - `pieceVersion` string
    - `type` 'BASIC_AUTH', required
    - `value` object, required
      - `username` string, required
      - `password` string, required
      - `type` 'BASIC_AUTH', required
    - `scope` 'PLATFORM', required
    - `projectIds` string[], required
    - `externalId` string
    - `preSelectForNewProjects` boolean
  - object
    - `displayName` string, required
    - `pieceName` string, required
    - `metadata` object
    - `pieceVersion` string
    - `type` 'CUSTOM_AUTH', required
    - `value` object, required
      - `type` 'CUSTOM_AUTH', required
      - `props` object, required
    - `scope` 'PLATFORM', required
    - `projectIds` string[], required
    - `externalId` string
    - `preSelectForNewProjects` boolean
  - object
    - `displayName` string, required
    - `pieceName` string, required
    - `metadata` object
    - `pieceVersion` string
    - `type` 'NO_AUTH', required
    - `value` object, required
      - `type` 'NO_AUTH', required
    - `scope` 'PLATFORM', required
    - `projectIds` string[], required
    - `externalId` string
    - `preSelectForNewProjects` boolean

## Response `201`

Default Response

- AppConnection
  - `id` string, required
  - `created` string, required
  - `updated` string, required
  - `externalId` string, required
  - `displayName` string, required
  - `type` 'OAUTH2' | 'PLATFORM_OAUTH2' | 'CLOUD_OAUTH2' | 'SECRET_TEXT' | 'BASIC_AUTH' | 'CUSTOM_AUTH' | 'NO_AUTH', required
  - `pieceName` string, required
  - `projectIds` string[], required
  - `platformId` string, nullable
  - `scope` 'PROJECT' | 'PLATFORM', required
  - `status` 'ACTIVE' | 'MISSING' | 'ERROR', required
  - `ownerId` string, nullable
  - `owner` User
    - `id` string, required
    - `email` string, required
    - `firstName` string, required
    - `status` 'ACTIVE' | 'INACTIVE', required
    - `externalId` string, nullable
    - `platformId` string, nullable
    - `platformRole` 'ADMIN' | 'MEMBER' | 'OPERATOR', required
    - `lastName` string, required
    - `created` string, required
    - `updated` string, required
    - `lastActiveDate` string, nullable
    - `imageUrl` string, nullable
  - `metadata` object, nullable
  - `flowIds` string[], nullable
  - `pieceVersion` string, required
  - `preSelectForNewProjects` boolean, required
  - `usingSecretManager` boolean, required

---

[API](https://skmtc.dev/activepieces/apis/activepieces-documentation.md) · [All operations](https://skmtc.dev/activepieces/apis/activepieces-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/activepieces/activepieces-documentation/revisions/745e4b7f764a/schema)