Zum Inhalt springen
GigadriveDocs

Organization settings

What an organization stores, how to create one, and which fields are fixed for the life of the organization.

An organization is created from a name, and its slug is derived from that name. Neither can be changed afterwards, and an organization cannot be deleted.

The organization record

FieldRulesNotes
idUUIDThe identifier every organization-scoped API takes
name1 to 128 charactersDisplay name, set once at creation
slugUp to 128 characters, uniqueDerived from the name, used in Gigadrive console URLs
imageUrlURLA shared Gigadrive placeholder until an avatar is set
createdAt/updatedAtISO 8601 stringsTimestamps

How the slug is derived

The name is lowercased and trimmed, every run of characters outside a-z, 0-9 and - becomes a single -, repeated hyphens collapse, and leading or trailing hyphens are stripped. Acme Corp becomes acme-corp. If that slug is already taken, a five-character random suffix is appended, so you may end up with acme-corp-k3f9a.

You cannot choose the slug. POST /organizations accepts a name and nothing else.

Creating an organization

The authenticated user becomes the organization's OWNER. Creation is atomic, so a half-created organization without an owner is not a state you can land in.

import { GigadriveClient } from '@gigadrive/sdk';

// Only user-backed tokens can create an organization, so this needs an access
// token from Gigadrive IDP rather than an API key.
const client = new GigadriveClient({ bearerToken: process.env.GIGADRIVE_ACCESS_TOKEN });

const organization = await client.organizations.create({ name: 'Acme Corp' });
console.log(organization.id, organization.slug);

The endpoint requires the platform:organizations:write scope and a USER actor. Organization, application, deployment and function tokens are refused with 403, because a machine credential has no person to make the owner. See Scopes for how actors and scopes interact.

Creation limits

LimitValueWhat it counts
Organizations you can own10Memberships where you are OWNER. ADMIN and MEMBER do not count.
Organizations you can own without billing2Owned organizations with no saved payment method
Creation attempts5 per hourPer user. Attempts the quotas then reject still consume the window.

An organization stops counting against the second limit as soon as it has a default payment method, so adding one to an existing organization frees a slot immediately. The checks run in order: rate limit first, then the ownership quota, then the unverified-billing budget.

What cannot be changed

There is no rename, no slug change, no delete, and no ownership transfer. The organization API is create and read only. If a name is wrong, create a new organization and move work across.

Settings in the console

An organization has three settings pages, and none of them edit the organization record itself:

  • Variables sets environment variables shared by every application in the organization.
  • Limits shows each resource quota with live usage against it, so you can see where you stand before an enforcement error. See Quotas.
  • Billing holds the plan, seats, budget, billing address and payment method. See Billing.