From da61e7cdca29428a22819c3077a7f00d5c17f5ae Mon Sep 17 00:00:00 2001
From: "ekline[bot]" <202747777+ekline[bot]@users.noreply.github.com>
Date: Fri, 26 Jun 2026 20:08:01 +0000
Subject: [PATCH] docs: document slug and properties when creating an
organization
ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
---
.../manage-users-orgs/create-organization.mdx | 84 +++++++++++++++++++
1 file changed, 84 insertions(+)
diff --git a/src/content/docs/authenticate/manage-users-orgs/create-organization.mdx b/src/content/docs/authenticate/manage-users-orgs/create-organization.mdx
index 893de3989..64f676bd2 100644
--- a/src/content/docs/authenticate/manage-users-orgs/create-organization.mdx
+++ b/src/content/docs/authenticate/manage-users-orgs/create-organization.mdx
@@ -148,4 +148,88 @@ Organization fetched = scalekitClient.organizations().getById(organization.getId
+### Set organization properties at creation
+
+Pass additional properties when you create an organization to give it a slug, map it to your own system, or brand its hosted pages. Every property except the display name is optional.
+
+| Property | Description |
+|---|---|
+| `display_name` | Human-readable name shown in the dashboard and hosted UI. Required. |
+| `slug` | DNS-safe identifier such as `orion` or `auth.orion-analytics.com`. Expands `{{org_slug}}` in [template redirect URLs](/guides/dashboard/org-redirect-urls/). |
+| `external_id` | Your own identifier for the organization, so you can look it up by your system's ID. |
+| `logo_url` | Publicly accessible logo URL shown on [branded login pages and portals](/fsa/guides/organization-branding/). |
+
+
+
+
+```javascript title="Create an organization with properties" wrap
+const { organization } = await scalekit.organization.createOrganization(
+ 'Orion Analytics',
+ {
+ slug: 'orion',
+ externalId: 'customer_12345',
+ logoUrl: 'https://cdn.orion-analytics.com/logo.png',
+ }
+);
+```
+
+
+
+
+```python title="Create an organization with properties" wrap
+from scalekit.v1.organizations.organizations_pb2 import CreateOrganization
+
+response = scalekit_client.organization.create_organization(
+ CreateOrganization(
+ display_name="Orion Analytics",
+ slug="orion",
+ external_id="customer_12345",
+ logo_url="https://cdn.orion-analytics.com/logo.png",
+ )
+)
+```
+
+
+
+
+```go title="Create an organization with properties" wrap
+slug := "orion"
+externalID := "customer_12345"
+logoURL := "https://cdn.orion-analytics.com/logo.png"
+
+created, err := scalekitClient.Organization().CreateOrganization(
+ ctx,
+ "Orion Analytics",
+ scalekit.CreateOrganizationOptions{
+ Slug: &slug,
+ ExternalId: &externalID,
+ LogoUrl: &logoURL,
+ },
+)
+if err != nil {
+ log.Fatalf("create organization: %v", err)
+}
+```
+
+
+
+
+```java title="Create an organization with properties" wrap
+CreateOrganization createOrganization = CreateOrganization.newBuilder()
+ .setDisplayName("Orion Analytics")
+ .setSlug("orion")
+ .setExternalId("customer_12345")
+ .setLogoUrl("https://cdn.orion-analytics.com/logo.png")
+ .build();
+
+Organization organization = scalekitClient.organizations().create(createOrganization);
+```
+
+
+
+
+
+
Next, let's look at how users can be added to organizations.