Pipedream Accounts API

The Accounts API from Pipedream — 4 operation(s) for accounts.

Operations 6

GET /v1/connect/{project_id}/accounts List Accounts #
POST /v1/connect/{project_id}/accounts Create Account #
GET /v1/connect/{project_id}/accounts/{account_id} Retrieve Account #
DELETE /v1/connect/{project_id}/accounts/{account_id} Delete Account #
DELETE /v1/connect/{project_id}/apps/{app_id}/accounts Delete Accounts by App #
DELETE /v1/connect/{project_id}/users/{external_user_id} Delete External User #

Documentation

Specifications

Schemas & Data

Other Resources

🔗
OpenAPIUpstream
https://pipedream.com/docs/pipedream_openapi_swagger.json
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/rules/pipedream-rules.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/examples/pipedream-list-apps-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/examples/pipedream-create-connect-token-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/examples/pipedream-list-accounts-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/examples/pipedream-run-action-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/examples/pipedream-deploy-trigger-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/examples/pipedream-oauth-token-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/examples/pipedream-proxy-request-example.json
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/graphql/pipedream-graphql.md
🔗
SDKs
https://pipedream.com/docs/connect/api-reference/sdks
🔗
SDKs
https://github.com/PipedreamHQ/pipedream-sdk-typescript
🔗
SDKs
https://github.com/PipedreamHQ/pipedream-sdk-python
🔗
SDKs
https://github.com/PipedreamHQ/pipedream-sdk-java
🔗
SamplesRepo
https://github.com/PipedreamHQ/pipedream-connect-examples
🔗
ServerDirectory
https://mcp.pipedream.com/
🔗
ChatClient
https://chat.pipedream.com/
🔗
SamplesRepo
https://github.com/PipedreamHQ/mcp-chat
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/examples/pipedream-mcp-tools-list-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/examples/pipedream-mcp-tools-call-example.json
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-account-audit-cleanup-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-app-discovery-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-configure-component-prop-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-connect-account-onboarding-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-deploy-trigger-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-pause-deployed-trigger-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-project-environment-webhook-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-provision-project-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-reload-component-props-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-rotate-trigger-webhook-key-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-run-action-for-app-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-set-trigger-webhooks-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-set-trigger-workflows-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-token-validation-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-trigger-events-poll-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-update-project-settings-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-usage-and-users-report-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/pipedream/refs/heads/main/arazzo/pipedream-user-offboarding-workflow.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/pipedream-accounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

pipedream-accounts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: '2026-05-22'
  title: Pipedream Accounts API
  description: 'The Pipedream API is the unified REST surface for Pipedream''s workflow automation, Connect (embedded integrations), MCP, and proxy services. It exposes account, user, component, action, trigger, deployed-trigger, webhook, project, proxy, file_stash, token, usage, and OAuth endpoints. Authentication is via OAuth 2.0 client credentials or a short-lived Connect token. Source: https://pipedream.com/docs/pipedream_openapi_swagger.json'
  contact:
    name: Pipedream
    url: https://pipedream.com/docs/
  license:
    name: Proprietary
    url: https://pipedream.com/terms
servers:
- url: https://api.pipedream.com
tags:
- name: Accounts
paths:
  /v1/connect/{project_id}/accounts:
    parameters:
    - name: project_id
      in: path
      required: true
      description: The project ID, which starts with `proj_`.
      schema:
        type: string
        pattern: ^proj_[a-zA-Z0-9]+$
      x-fern-sdk-variable: project_id
    - name: external_user_id
      in: query
      required: false
      schema:
        type: string
    - name: oauth_app_id
      in: query
      required: false
      description: The OAuth app ID to filter by, if applicable
      schema:
        type: string
        pattern: ^oa_[0-9a-zA-Z]+$
    get:
      summary: List Accounts
      description: Retrieve all connected accounts for the project with optional filtering
      parameters:
      - name: x-pd-environment
        in: header
        required: true
        description: The environment in which the server client is running
        schema:
          $ref: '#/components/schemas/ProjectEnvironment'
      - name: after
        in: query
        required: false
        description: The cursor to start from for pagination
        schema:
          type: string
      - name: before
        in: query
        required: false
        description: The cursor to end before for pagination
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: The maximum number of results to return
        schema:
          type: integer
      - name: app
        in: query
        required: false
        description: The app slug or ID to filter accounts by.
        schema:
          type: string
      - name: include_credentials
        in: query
        description: Whether to retrieve the account's credentials or not
        schema:
          type: boolean
      operationId: listAccounts
      x-fern-sdk-group-name: accounts
      x-fern-sdk-method-name: list
      x-fern-pagination:
        cursor: $request.after
        next_cursor: $response.page_info.end_cursor
        results: $response.data
      security:
      - ConnectToken: []
      - OAuth2: []
      responses:
        '200':
          description: accounts listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAccountsResponse'
        '429':
          description: too many requests
          headers:
            Retry-After:
              description: Number of seconds until the rate limit resets
              schema:
                type: integer
            X-RateLimit-Limit:
              schema:
                type: integer
              description: The rate limit threshold
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Number of requests remaining (always 0 when throttled)
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix timestamp when the rate limit resets
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Throttled
      x-codeSamples:
      - lang: java
        label: Java SDK
        source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\nimport com.pipedream.api.resources.accounts.requests.AccountsListRequest;\n\npublic class Example {\n  public static void main(String[] args) {\n  BaseClient client = BaseClient\n    .builder()\n    .clientId(\"<clientId>\")\n    .clientSecret(\"<clientSecret>\")\n    .projectId(\"YOUR_PROJECT_ID\")\n    .build();\n\n  client.accounts().list(\n    AccountsListRequest\n    .builder()\n    .build()\n  );\n  }\n}\n"
      - lang: typescript
        label: TypeScript SDK
        source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n  clientId: \"YOUR_CLIENT_ID\",\n  clientSecret: \"YOUR_CLIENT_SECRET\",\n  projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n  projectId: \"YOUR_PROJECT_ID\"\n});\nconst response = await client.accounts.list({\n  externalUserId: \"external_user_id\",\n  oauthAppId: \"oauth_app_id\",\n  after: \"after\",\n  before: \"before\",\n  limit: 1,\n  app: \"app\",\n  includeCredentials: true\n});\nfor await (const item of response) {\n  console.log(item);\n}\n\n// Or you can manually iterate page-by-page\nlet page = await client.accounts.list({\n  externalUserId: \"external_user_id\",\n  oauthAppId: \"oauth_app_id\",\n  after: \"after\",\n  before: \"before\",\n  limit: 1,\n  app: \"app\",\n  includeCredentials: true\n});\nwhile (page.hasNextPage()) {\n  page = page.getNextPage();\n}\n"
      - lang: python
        label: Python SDK
        source: "from pipedream import Pipedream\n\nclient = Pipedream(\n  project_id=\"YOUR_PROJECT_ID\",\n  project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n  client_id=\"YOUR_CLIENT_ID\",\n  client_secret=\"YOUR_CLIENT_SECRET\",\n)\nresponse = client.accounts.list(\n  external_user_id=\"external_user_id\",\n  oauth_app_id=\"oauth_app_id\",\n  after=\"after\",\n  before=\"before\",\n  limit=1,\n  app=\"app\",\n  include_credentials=True,\n)\nfor item in response:\n  yield item\n# alternatively, you can paginate page-by-page\nfor page in response.iter_pages():\n  yield page\n"
      tags:
      - Accounts
    post:
      summary: Create Account
      description: Connect a new account for an external user in the project
      parameters:
      - name: x-pd-environment
        in: header
        required: true
        description: The environment in which the server client is running
        schema:
          $ref: '#/components/schemas/ProjectEnvironment'
      operationId: createAccount
      x-fern-sdk-group-name: accounts
      x-fern-sdk-method-name: create
      security:
      - ConnectToken: []
      responses:
        '200':
          description: account created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '429':
          description: too many requests
          headers:
            Retry-After:
              description: Number of seconds until the rate limit resets
              schema:
                type: integer
            X-RateLimit-Limit:
              schema:
                type: integer
              description: The rate limit threshold
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Number of requests remaining (always 0 when throttled)
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix timestamp when the rate limit resets
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Throttled
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccountOpts'
      x-codeSamples:
      - lang: java
        label: Java SDK
        source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\nimport com.pipedream.api.resources.accounts.requests.CreateAccountOpts;\n\npublic class Example {\n  public static void main(String[] args) {\n  BaseClient client = BaseClient\n    .builder()\n    .clientId(\"<clientId>\")\n    .clientSecret(\"<clientSecret>\")\n    .projectId(\"YOUR_PROJECT_ID\")\n    .build();\n\n  client.accounts().create(\n    CreateAccountOpts\n    .builder()\n    .appSlug(\"app_slug\")\n    .cfmapJson(\"cfmap_json\")\n    .connectToken(\"connect_token\")\n    .build()\n  );\n  }\n}\n"
      - lang: typescript
        label: TypeScript SDK
        source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n  clientId: \"YOUR_CLIENT_ID\",\n  clientSecret: \"YOUR_CLIENT_SECRET\",\n  projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n  projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.accounts.create({\n  externalUserId: \"external_user_id\",\n  oauthAppId: \"oauth_app_id\",\n  appSlug: \"app_slug\",\n  cfmapJson: \"cfmap_json\",\n  connectToken: \"connect_token\"\n});\n"
      - lang: python
        label: Python SDK
        source: "from pipedream import Pipedream\n\nclient = Pipedream(\n  project_id=\"YOUR_PROJECT_ID\",\n  project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n  client_id=\"YOUR_CLIENT_ID\",\n  client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.accounts.create(\n  external_user_id=\"external_user_id\",\n  oauth_app_id=\"oauth_app_id\",\n  app_slug=\"app_slug\",\n  cfmap_json=\"cfmap_json\",\n  connect_token=\"connect_token\",\n)\n"
      tags:
      - Accounts
  /v1/connect/{project_id}/accounts/{account_id}:
    parameters:
    - name: project_id
      in: path
      required: true
      description: The project ID, which starts with `proj_`.
      schema:
        type: string
        pattern: ^proj_[a-zA-Z0-9]+$
      x-fern-sdk-variable: project_id
    - name: account_id
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Retrieve Account
      description: Get the details for a specific connected account
      parameters:
      - name: x-pd-environment
        in: header
        required: true
        description: The environment in which the server client is running
        schema:
          $ref: '#/components/schemas/ProjectEnvironment'
      - name: include_credentials
        in: query
        description: Whether to retrieve the account's credentials or not
        schema:
          type: boolean
      operationId: retrieveAccount
      x-fern-sdk-group-name: accounts
      x-fern-sdk-method-name: retrieve
      security:
      - ConnectToken: []
      - OAuth2: []
      responses:
        '200':
          description: account retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '429':
          description: too many requests
          headers:
            Retry-After:
              description: Number of seconds until the rate limit resets
              schema:
                type: integer
            X-RateLimit-Limit:
              schema:
                type: integer
              description: The rate limit threshold
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Number of requests remaining (always 0 when throttled)
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix timestamp when the rate limit resets
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Throttled
      x-codeSamples:
      - lang: java
        label: Java SDK
        source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\nimport com.pipedream.api.resources.accounts.requests.AccountsRetrieveRequest;\n\npublic class Example {\n  public static void main(String[] args) {\n  BaseClient client = BaseClient\n    .builder()\n    .clientId(\"<clientId>\")\n    .clientSecret(\"<clientSecret>\")\n    .projectId(\"YOUR_PROJECT_ID\")\n    .build();\n\n  client.accounts().retrieve(\n    \"account_id\",\n    AccountsRetrieveRequest\n    .builder()\n    .includeCredentials(true)\n    .build()\n  );\n  }\n}\n"
      - lang: typescript
        label: TypeScript SDK
        source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n  clientId: \"YOUR_CLIENT_ID\",\n  clientSecret: \"YOUR_CLIENT_SECRET\",\n  projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n  projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.accounts.retrieve(\"account_id\", {\n  includeCredentials: true\n});\n"
      - lang: python
        label: Python SDK
        source: "from pipedream import Pipedream\n\nclient = Pipedream(\n  project_id=\"YOUR_PROJECT_ID\",\n  project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n  client_id=\"YOUR_CLIENT_ID\",\n  client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.accounts.retrieve(\n  account_id=\"account_id\",\n  include_credentials=True,\n)\n"
      tags:
      - Accounts
    delete:
      summary: Delete Account
      description: Remove a connected account and its associated credentials
      parameters:
      - name: x-pd-environment
        in: header
        required: true
        description: The environment in which the server client is running
        schema:
          $ref: '#/components/schemas/ProjectEnvironment'
      operationId: deleteAccount
      x-fern-sdk-group-name: accounts
      x-fern-sdk-method-name: delete
      security:
      - ConnectToken: []
      - OAuth2: []
      responses:
        '204':
          description: account deleted
        '429':
          description: too many requests
          headers:
            Retry-After:
              description: Number of seconds until the rate limit resets
              schema:
                type: integer
            X-RateLimit-Limit:
              schema:
                type: integer
              description: The rate limit threshold
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Number of requests remaining (always 0 when throttled)
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix timestamp when the rate limit resets
      x-codeSamples:
      - lang: java
        label: Java SDK
        source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\n\npublic class Example {\n  public static void main(String[] args) {\n  BaseClient client = BaseClient\n    .builder()\n    .clientId(\"<clientId>\")\n    .clientSecret(\"<clientSecret>\")\n    .projectId(\"YOUR_PROJECT_ID\")\n    .build();\n\n  client.accounts().delete(\"account_id\");\n  }\n}\n"
      - lang: typescript
        label: TypeScript SDK
        source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n  clientId: \"YOUR_CLIENT_ID\",\n  clientSecret: \"YOUR_CLIENT_SECRET\",\n  projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n  projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.accounts.delete(\"account_id\");\n"
      - lang: python
        label: Python SDK
        source: "from pipedream import Pipedream\n\nclient = Pipedream(\n  project_id=\"YOUR_PROJECT_ID\",\n  project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n  client_id=\"YOUR_CLIENT_ID\",\n  client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.accounts.delete(\n  account_id=\"account_id\",\n)\n"
      tags:
      - Accounts
  /v1/connect/{project_id}/apps/{app_id}/accounts:
    parameters:
    - name: project_id
      in: path
      required: true
      description: The project ID, which starts with `proj_`.
      schema:
        type: string
        pattern: ^proj_[a-zA-Z0-9]+$
      x-fern-sdk-variable: project_id
    - name: app_id
      in: path
      required: true
      schema:
        type: string
    delete:
      summary: Delete Accounts by App
      description: Remove all connected accounts for a specific app
      parameters:
      - name: x-pd-environment
        in: header
        required: true
        description: The environment in which the server client is running
        schema:
          $ref: '#/components/schemas/ProjectEnvironment'
      operationId: deleteAccountByApp
      x-fern-sdk-group-name: accounts
      x-fern-sdk-method-name: deleteByApp
      security:
      - ConnectToken: []
      - OAuth2: []
      responses:
        '204':
          description: accounts deleted
        '429':
          description: too many requests
          headers:
            Retry-After:
              description: Number of seconds until the rate limit resets
              schema:
                type: integer
            X-RateLimit-Limit:
              schema:
                type: integer
              description: The rate limit threshold
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Number of requests remaining (always 0 when throttled)
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix timestamp when the rate limit resets
      x-codeSamples:
      - lang: java
        label: Java SDK
        source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\n\npublic class Example {\n  public static void main(String[] args) {\n  BaseClient client = BaseClient\n    .builder()\n    .clientId(\"<clientId>\")\n    .clientSecret(\"<clientSecret>\")\n    .projectId(\"YOUR_PROJECT_ID\")\n    .build();\n\n  client.accounts().deleteByApp(\"app_id\");\n  }\n}\n"
      - lang: typescript
        label: TypeScript SDK
        source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n  clientId: \"YOUR_CLIENT_ID\",\n  clientSecret: \"YOUR_CLIENT_SECRET\",\n  projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n  projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.accounts.deleteByApp(\"app_id\");\n"
      - lang: python
        label: Python SDK
        source: "from pipedream import Pipedream\n\nclient = Pipedream(\n  project_id=\"YOUR_PROJECT_ID\",\n  project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n  client_id=\"YOUR_CLIENT_ID\",\n  client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.accounts.delete_by_app(\n  app_id=\"app_id\",\n)\n"
      tags:
      - Accounts
  /v1/connect/{project_id}/users/{external_user_id}:
    parameters:
    - name: project_id
      in: path
      required: true
      description: The project ID, which starts with `proj_`.
      schema:
        type: string
        pattern: ^proj_[a-zA-Z0-9]+$
      x-fern-sdk-variable: project_id
    - name: external_user_id
      in: path
      required: true
      schema:
        type: string
    delete:
      summary: Delete External User
      description: Remove an external user and all their associated accounts and resources
      parameters:
      - name: x-pd-environment
        in: header
        required: true
        description: The environment in which the server client is running
        schema:
          $ref: '#/components/schemas/ProjectEnvironment'
      operationId: deleteUserExternalUser
      x-fern-sdk-group-name: users
      x-fern-sdk-method-name: deleteExternalUser
      security:
      - ConnectToken: []
      - OAuth2: []
      responses:
        '204':
          description: external user deleted
        '429':
          description: too many requests
          headers:
            Retry-After:
              description: Number of seconds until the rate limit resets
              schema:
                type: integer
            X-RateLimit-Limit:
              schema:
                type: integer
              description: The rate limit threshold
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Number of requests remaining (always 0 when throttled)
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix timestamp when the rate limit resets
      x-codeSamples:
      - lang: java
        label: Java SDK
        source: "package com.example.usage;\n\nimport com.pipedream.api.BaseClient;\n\npublic class Example {\n  public static void main(String[] args) {\n  BaseClient client = BaseClient\n    .builder()\n    .clientId(\"<clientId>\")\n    .clientSecret(\"<clientSecret>\")\n    .projectId(\"YOUR_PROJECT_ID\")\n    .build();\n\n  client.users().deleteExternalUser(\"external_user_id\");\n  }\n}\n"
      - lang: typescript
        label: TypeScript SDK
        source: "import { PipedreamClient } from \"@pipedream/sdk\";\n\nconst client = new PipedreamClient({\n  clientId: \"YOUR_CLIENT_ID\",\n  clientSecret: \"YOUR_CLIENT_SECRET\",\n  projectEnvironment: \"YOUR_PROJECT_ENVIRONMENT\",\n  projectId: \"YOUR_PROJECT_ID\"\n});\nawait client.users.deleteExternalUser(\"external_user_id\");\n"
      - lang: python
        label: Python SDK
        source: "from pipedream import Pipedream\n\nclient = Pipedream(\n  project_id=\"YOUR_PROJECT_ID\",\n  project_environment=\"YOUR_PROJECT_ENVIRONMENT\",\n  client_id=\"YOUR_CLIENT_ID\",\n  client_secret=\"YOUR_CLIENT_SECRET\",\n)\nclient.users.delete_external_user(\n  external_user_id=\"external_user_id\",\n)\n"
      tags:
      - Accounts
components:
  schemas:
    AppAuthType:
      type:
      - string
      - 'null'
      enum:
      - keys
      - oauth
      - none
      description: The authentication type used by the app
    Account:
      type: object
      description: End user account data, returned from the API.
      required:
      - id
      properties:
        id:
          $ref: '#/components/schemas/AccountId'
        name:
          type:
          - string
          - 'null'
          description: The custom name of the account if set.
        external_id:
          type: string
          description: The external ID associated with the account.
        healthy:
          type: boolean
          description: Indicates if the account is healthy. Pipedream will periodically retry token refresh and test requests for unhealthy accounts
        dead:
          type:
          - boolean
          - 'null'
          description: Indicates if the account is no longer active
        app:
          $ref: '#/components/schemas/App'
        created_at:
          type: string
          description: The date and time the account was created, an ISO 8601 formatted string
          format: date-time
        updated_at:
          type: string
          description: The date and time the account was last updated, an ISO 8601 formatted string
          format: date-time
        authorized_scopes:
          type: array
          items:
            type: string
          description: The OAuth scopes effectively granted to this account. Empty for non-OAuth apps.
        credentials:
          type:
          - object
          - 'null'
          description: The credentials associated with the account, if the `include_credentials` parameter was set to true in the request (only applicable for BYOA apps). In addition to the well-known OAuth fields listed below, this object may contain app-specific custom fields (e.g. `base_url`).
          additionalProperties: true
          properties:
            oauth_client_id:
              type: string
              description: The OAuth client ID for the app, if applicable
            oauth_access_token:
              type: string
              description: The OAuth access token
            oauth_refresh_token:
              type: string
              description: The OAuth refresh token
            oauth_uid:
              type: string
              description: The unique OAuth user identifier
            oauth_signer_uri:
              type: string
              description: The OAuth signer URI, if the app uses a custom OAuth signer
        expires_at:
          type: string
          description: The date and time the account's credentials expiration, an ISO 8601 formatted string
          format: date-time
        error:
          type:
          - string
          - 'null'
          description: The error message if the account is unhealthy or dead, null otherwise
        last_refreshed_at:
          type:
          - string
          - 'null'
          description: The date and time the account was last refreshed, an ISO 8601 formatted string
          format: date-time
        next_refresh_at:
          type:
          - string
          - 'null'
          description: The date and time the account will next be refreshed, an ISO 8601 formatted string
          format: date-time
    PageInfo:
      type: object
      properties:
        count:
          type: integer
          description: Number of items returned
          example: 10
        total_count:
          type: integer
          description: Total number of items
          example: 120
        start_cursor:
          type:
          - string
          - 'null'
          description: Used to fetch the previous page of items
        end_cursor:
          type:
          - string
          - 'null'
          description: Used to fetch the next page of items
    ListAccountsResponse:
      type: object
      description: Response received when listing accounts
      required:
      - data
      - page_info
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Account'
        page_info:
          $ref: '#/components/schemas/PageInfo'
    AccountId:
      type: string
      description: The unique ID of the account.
      pattern: ^apn_[a-zA-Z0-9]+$
    App:
      type: object
      description: Response object for a Pipedream app's metadata
      required:
      - name_slug
      - name
      - img_src
      - custom_fields_json
      - categories
      - featured_weight
      properties:
        id:
          type:
          - string
          - 'null'
          description: ID of the app. Only applies for OAuth apps.
        name_slug:
          type: string
          description: The name slug of the target app (see https://pipedream.com/docs/connect/quickstart#find-your-apps-name-slug)
        name:
          type: string
          description: The human-readable name of the app
        auth_type:
          $ref: '#/components/schemas/AppAuthType'
        description:
          type:
          - string
          - 'null'
          description: A short description of the app
        img_src:
          type: string
          description: The URL to the app's logo
        custom_fields_json:
          type:
          - string
          - 'null'
          description: A JSON string representing the custom fields for the app
        categories:
          type: array
          items:
            type: string
          description: Categories associated with the app
        featured_weight:
          type: number
          description: A rough directional ordering of app popularity, subject to changes by Pipedream
    CreateAccountOpts:
      type: object
      description: Request object for creating an account
      required:
      - app_slug
      - cfmap_json
      - connect_token
      properties:
        app_slug:
          type: string
          description: The app slug for the account
        cfmap_json:
          type: string
          description: JSON string containing the custom fields mapping
        connect_token:
          type: string
          description: The connect token for authentication
        name:
          type: string
          description: Optional name for the account
        account_id:
          type: string
          description: An existing account ID to reconnect. When provided, the account's credentials are updated instead of creating a new account. Must belong to the same external user and project environment as the connect token, and match the app identified by app_slug.
    ProjectEnvironment:
      type: string
      description: The environment in which the server client is running
      enum:
      - development
      - production
  securitySchemes:
    OAuth2:
      description: A short-lived OAuth access token for server-side requests. Generate one via the Generate OAuth Token flow or automatically when initializing the SDK client.
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.pipedream.com/v1/oauth/token
          scopes:
            '*': Full access to every OAuth-protected endpoint.
            connect:*: Full access to all Connect API endpoints (components, projects, triggers, accounts, etc.).
            connect:actions:*: Full access to Connect actions.
            connect:triggers:*: Full access to Connect triggers.
            connect:accounts:read: List and fetch Connect accounts for an external user.
            connect:accounts:write: Create or remove Connect accounts.
            connect:deployed_triggers:read: Read deployed triggers and related data like events, pipelines and webhooks.
            connect:deployed_triggers:write: Modify or delete deployed triggers.
            connect:users:read: List and fetch external users
            connect:users:write: Delete external users.
            connect:projects:read: List and fetch projects owned by the workspace.
            connect:projects:write: Create, update, or delete projects owned by the workspace.
            connect:usage:read: List Connect usage records for a time window.
            connect:tokens:create: Create Connect session tokens.
            connect:proxy: Invoke the Connect proxy.
            connect:workflow:invoke: Invoke Connect workflows on behalf of a user.
    ConnectToken:
      description: A short-lived Connect token for client-side requests on behalf of an end user. Generate one via the Create Connect token endpoint.
      type: http
      scheme: bearer
      bearerFormat: ^ctok_[0-9a-f]{32}$
x-fern-sdk-variables:
  project_id:
    type: string