Airbyte · Schema

GroupCreateRequest

Request body for creating a group

Data IntegrationETLELTOpen SourceData PipelineConnectorsData

Properties

Name Type Description
name string The name of the group
description string Optional description of the group
organizationId string The ID of the organization the group belongs to
View JSON Schema on GitHub

JSON Schema

airbyte-group-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/json-schema/airbyte-group-create-request-schema.json",
  "title": "GroupCreateRequest",
  "description": "Request body for creating a group",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the group"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "description": "Optional description of the group"
    },
    "organizationId": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the organization the group belongs to"
    }
  },
  "required": [
    "name",
    "organizationId"
  ]
}