Organizations

An organization is the top-level tenant container in Scribase. It holds projects, members, environments, and the audit log. All resource paths are scoped under an organization ID.

Organization ID rules

• Lowercase alphanumeric and hyphens only.
• 2–64 characters.
• Must start and end with an alphanumeric character.

Endpoints

PUT /v1/organizations/{organization_id}

Create or update an organization.

Request body:

{ "display_name": "Acme Platform" }

Response 200 OK:

{
  "id": "acme",
  "display_name": "Acme Platform",
  "created_at": "2026-01-01T00:00:00Z"
}

Headers required: Idempotency-Key

Example:

scribase org put acme "Acme Platform"

GET /v1/organizations/{organization_id}

Read an organization record.

Response 200 OK:

{
  "id": "acme",
  "display_name": "Acme Platform",
  "created_at": "2026-01-01T00:00:00Z"
}

Example:

scribase org get acme

Memberships

Members are subjects (user IDs or service account IDs from your OIDC provider) with an assigned role.

PUT /v1/organizations/{organization_id}/memberships

Add or update a member's role.

Request body:

{ "subject": "user|abc123", "role": "developer" }

Roles:

Headers required: Idempotency-Key

Example:

scribase member put acme "user|abc123" developer

Audit events

See Audit Events for the organization audit log.