Skip to content

Create an organization

POST
/v1/organizations

A new organization will be created and the current user will
be the first member of the organization and get the admin role.
On successful creation the new membership object is resturned.

A SSO logged in user cannot create an organization.

Authorizations

jwtToken
TypeHTTP (bearer)

Request Body

application/json
JSON
{
"name": "terramate",
"display_name": "Terramate GmbH",
"domain": "terramate.io",
"github_owner": "terramate-io",
"gitlab_owner": "terramate-io",
"slack_webhook": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
}

Responses

Created

application/json
JSON
{
"member_id": 0,
"org_display_name": "Terramate GmbH",
"org_domain": "terramate.io",
"org_name": "terramate",
"org_uuid": "7af57dbe-4f8a-4046-b5f7-135a79f478b3",
"role": "admin",
"status": "active"
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI