الانتقال إلى المحتوى الرئيسي
POST
/
workspaces
/
{workspaceId}
/
organizations
إنشاء منظمة
curl --request POST \
  --url https://api.altostrat.io/workspaces/{workspaceId}/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Marketing Team",
  "billing_account_id": "cus_a1b2c3d4e5f6g7h8",
  "limits": {
    "locations": 5,
    "users": 20
  },
  "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...",
  "branding": {
    "display_name": "ACME Inc.",
    "login_hint": "acme-inc",
    "colors": {
      "primary": "#007bff"
    }
  }
}'
{
  "id": "org_aBcDeFg123456789",
  "name": "Engineering Department",
  "workspace_id": "ws_a1b2c3d4e5f6g7h8",
  "external_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "parent_org_id": "org_zYxWvUt987654321",
  "path": "org_root123#org_parent456",
  "depth": 2,
  "billing_account_id": "cus_a1b2c3d4e5f6g7h8",
  "picture": "https://cdn.altostrat.io/logos/engineering.png",
  "usage": {
    "usage": {
      "locations": 2,
      "users": 5
    },
    "subtree_usage": {
      "locations": 10,
      "users": 25
    }
  },
  "limits": {
    "locations": 10,
    "users": 50
  },
  "branding": {
    "display_name": "ACME Corp",
    "login_hint": "acme-corp",
    "colors": {
      "primary": "#FF5733",
      "page_background": "#FFFFFF"
    }
  }
}

Authorizations

​
Authorization
string
header
required

أدخل JWT الخاص بك بالتنسيق: Bearer {token}

Path Parameters

​
workspaceId
string
required

معرّف مساحة العمل.

Example:

"ws_a1b2c3d4e5f6g7h8"

Body

application/json
​
name
string
required

اسم المنظمة. 50 حرفًا كحد أقصى.

Example:

"Marketing Team"

​
billing_account_id
string | null

معرّف حساب الفوترة للربط. مطلوب للمنظمات الجذرية في أوضاع الفوترة single أو assigned. يجب أن يكون null للمنظمات الفرعية أو أي منظمة في وضع pooled.

Example:

"cus_a1b2c3d4e5f6g7h8"

​
limits
object

تعيين حدود الموارد للمنظمة. المفاتيح هي أنواع قابلة للقياس (locations, users, sso). القيمة null تزيل الحد، والقيمة 0 تعطل المورد.

Example:
{ "locations": 5, "users": 20 }
​
picture
string | null

رابط URL عام بصيغة HTTPS لصورة أو URI بيانات مشفرة بـ base64. ستتم معالجة الصورة واستضافتها بواسطة Altostrat. يجب أن تكون بصيغة JPEG أو PNG أو GIF وأقل من 2 ميغابايت.

Example:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."

​
branding
object

إعدادات العلامة التجارية للمنظمة.

Response

تم إنشاء المنظمة بنجاح.

​
id
string

معرّف فريد للمنظمة (يتوافق مع معرّف منظمة Auth0)، يبدأ بالبادئة org_.

Example:

"org_aBcDeFg123456789"

​
name
string

الاسم القابل للقراءة البشرية للمنظمة.

Example:

"Engineering Department"

​
workspace_id
string

معرّف مساحة العمل التي تنتمي إليها هذه المنظمة.

Example:

"ws_a1b2c3d4e5f6g7h8"

​
external_id
string<uuid>

معرّف مستقر وفريد للمنظمة، مستقل عن معرّف Auth0 الخاص بها.

Example:

"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"

​
parent_org_id
string | null

معرّف المنظمة الرئيسية، إذا كانت هذه منظمة فرعية.

Example:

"org_zYxWvUt987654321"

​
path
string | null

سلسلة نصية مفصولة بـ # تمثل المسار الهرمي للأسلاف.

Example:

"org_root123#org_parent456"

​
depth
integer

عمق المنظمة في التسلسل الهرمي (0 للمستوى الأعلى).

Example:

2

​
billing_account_id
string | null

معرّف حساب الفوترة المرتبط بهذه المنظمة (في وضع assigned).

Example:

"cus_a1b2c3d4e5f6g7h8"

​
picture
string<uri> | null

رابط URL لشعار المنظمة.

Example:

"https://cdn.altostrat.io/logos/engineering.png"

​
usage
object
​
limits
object

خريطة لحدود الموارد المطبقة مباشرة على هذه المنظمة. المفاتيح هي أنواع قابلة للقياس (locations, users, sso). القيمة null أو عدم وجود مفتاح يعني عدم تعيين حد على هذا المستوى. القيمة 0 تعني أن المورد معطل بشكل صريح.

Example:
{ "locations": 10, "users": 50 }
​
branding
object