Terrakube
Home
2.21.0
2.21.0
  • Introduction
  • Updates
  • Getting started
    • ๐Ÿ“Architecture
    • ๐Ÿ”Security
    • ๐Ÿš€Getting Started
    • ๐Ÿ’ฟDocker Images
    • ๐ŸŒDocker Compose
    • ๐Ÿš—Docker Compose + Traefik
    • ๐Ÿ“ฅDeployment
      • ๐Ÿ”จHelm Chart
      • ๐Ÿš€Minikube
      • ๐Ÿ”‘Minikube + HTTPS
      • โœˆ๏ธIngress Configuration
      • ๐Ÿ”User Authentication (DEX)
      • ๐Ÿ’พStorage backend
        • Azure Storage Account
        • Amazon Cloud Storage
        • Google Cloud Storage
        • Minio (S3 compatible)
      • ๐Ÿ›ฐ๏ธDatabase Backend
        • SQL Azure
        • PostgreSQL
        • MySQL
        • H2
      • ๐Ÿ”Custom CA Certs
      • โš™๏ธCustom Terraform CLI Builds
      • ๐Ÿ‘ฎSelf-Hosted Agents
      • ๐Ÿ“ถProxy Configuration
      • ๐Ÿ›ก๏ธToken Security
      • ๐ŸšฆOpen Telemetry
    • ๐ŸคตUser Management
      • Azure Active Directory
      • Google Cloud Identity
      • Amazon Cognito
      • Github
  • ๐Ÿ““User Guide
    • Organizations
      • Creating an Organization
      • Global Variables
      • Team Management
      • API Tokens
      • Templates
        • Default Templates
        • Persistent Context
        • Import Templates
        • UI Templates
        • Filter global variables in jobs
        • Template Scheduling in Jobs
      • Tags
    • VCS Providers
      • Github
      • Github Enterprise
      • GitLab
      • Gitlab EE and CE
      • Bitbucket
      • Azure DevOps
      • SSH
    • Workspaces
      • Overview
      • Creating Workspaces
      • Terraform State
      • Share Workspace State
      • Variables
      • Dynamic Provider Credentials
        • AWS Dynamic Provider Credentials
        • Azure Dynamic Provider Credentials
        • GCP Dynamic Provider Credentials
      • Workspace scheduler
      • API-driven Workflow
      • CLI-driven Workflow
      • Ephemeral Workspaces
      • Actions
        • Developing Actions
          • Quick start
          • Display Criteria
          • Action Types
          • Action Context
          • Action Proxy
        • Built-in Actions
          • Open Documentation
          • Resource Details
          • Open in Azure Portal
          • Restart Azure VM
          • Azure Monitor
          • Open AI
    • Private Registry
      • Publishing Private Modules
      • Using Private Modules
    • Policy Enforcement (OPA)
    • Cost Estimation
    • Drift Detection
    • CI/CD Integration
      • Github Actions
      • Bitbucket
    • Terrakube CLI
      • Getting started
      • Installation
      • Commands
        • terrakube login
        • terrakube logout
        • terrakube organization
          • organization list
          • organization create
          • organization update
          • organization delete
        • terrakube team
          • team list
          • team create
          • team update
          • team delete
        • terrakube workspace
          • workspace list
          • workspace create
          • workspace update
          • workspace delete
          • workspace variable
            • variable list
        • terrakube variable
          • variable update
          • variable delete
          • variable create
        • terrakube job
          • job list
          • job create
        • terrakube module
          • module list
          • module create
          • module update
          • module delete
    • Reference
      • Executor
        • Terraform Execution Flow
        • Terraform Versions
    • Migrating to Terrakube
  • ๐ŸŽ“Learn
    • What is Terrakube
      • Section Overview
      • Terraform in a Nutshell
      • Terraform Challenges at Enterprise Level
      • Introducing Terrakube
      • Summary and Up Next
    • Deploying using Terrakube
  • ๐Ÿ“–API
    • ๐ŸŒŸGetting started
    • โš™๏ธMethods
      • Globalvar
      • Organization
      • Teams
      • Workspace
      • Variables
      • History
      • Jobs
      • Template
      • Schedule
      • Step
      • Module
      • Vcs
      • Provider
      • Personal Access Token
      • Team API Tokens
      • SSH Key
      • Agent
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
Export as PDF
  1. API
  2. Methods

Organization

This endpoint is used to create, update, search or delete organizations information inside Terrakube.

You need to be part of the administrator Active Directory Group to work with this endpoint

The default group is handled using the Spring Boot property

org.azbuilder.owner=TERRAKUBE_ADMIN

Entity fields:

Path
Type
Description

data.type

string

Should be "organization"

data.attributes.name

string

Unique name in Terrakube

data.attributes.description

string

Free description

Example:

{
  "data": {
    "type": "organization",
    "attributes": {
      "name": "terrakube",
      "description": "Terrakube Organization"
    }
  }
}

Supported Operations

PreviousGlobalvarNextTeams

Last updated 11 months ago

Was this helpful?

For a complete list of organization operation please visit the

๐Ÿ“–
โš™๏ธ
OpenAPI specification
get

Returns the collection of type organization

Query parameters
filter[organization]stringOptional

Filters the collection of organization using a 'disjoint' RSQL expression

filterstringOptional

Filters the collection of organization using a 'joined' RSQL expression

page[number]integerOptional

Number of pages to return. Can be used with page[size]

page[size]integerOptional

Number of elements per page. Can be used with page[number]

page[offset]integerOptional

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integerOptional

Maximum number of items to return. Can be used with page[offset]

page[totals]stringOptional

For requesting total pages/records be included in the response page meta data

Responses
200
Successful response
application/vnd.api+json
get
GET /api/v1/organization HTTP/1.1
Host: 
Accept: */*
200

Successful response

{
  "data": [],
  "included": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}
delete

Deletes an instance of type organization

Path parameters
organizationIdanyRequired

organization Identifier

Responses
204
Successful response
delete
DELETE /api/v1/organization/{organizationId} HTTP/1.1
Host: 
Accept: */*
204

Successful response

No content

  • Entity fields:
  • Example:
  • Supported Operations
  • GET/organization
  • POST/organization
  • DELETE/organization/{organizationId}
  • PATCH/organization/{organizationId}
post

Creates an item of type organization

Body
Responses
201
Successful response
application/vnd.api+json
post
POST /api/v1/organization HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 375

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "description": "text",
      "name": "text"
    },
    "relationships": {
      "job": {
        "id": "text",
        "type": "job"
      },
      "module": {
        "id": "text",
        "type": "module"
      },
      "provider": {
        "id": "text",
        "type": "provider"
      },
      "team": {
        "id": "text",
        "type": "team"
      },
      "template": {
        "id": "text",
        "type": "template"
      },
      "vcs": {
        "id": "text",
        "type": "vcs"
      },
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  }
}
201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "description": "text",
      "name": "text"
    },
    "relationships": {
      "job": {
        "id": "text",
        "type": "job"
      },
      "module": {
        "id": "text",
        "type": "module"
      },
      "provider": {
        "id": "text",
        "type": "provider"
      },
      "team": {
        "id": "text",
        "type": "team"
      },
      "template": {
        "id": "text",
        "type": "template"
      },
      "vcs": {
        "id": "text",
        "type": "vcs"
      },
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  }
}
patch

Modifies an instance of type organization

Path parameters
organizationIdanyRequired

organization Identifier

Body
Responses
204
Successful response
patch
PATCH /api/v1/organization/{organizationId} HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 375

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "description": "text",
      "name": "text"
    },
    "relationships": {
      "job": {
        "id": "text",
        "type": "job"
      },
      "module": {
        "id": "text",
        "type": "module"
      },
      "provider": {
        "id": "text",
        "type": "provider"
      },
      "team": {
        "id": "text",
        "type": "team"
      },
      "template": {
        "id": "text",
        "type": "template"
      },
      "vcs": {
        "id": "text",
        "type": "vcs"
      },
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  }
}
204

Successful response

No content