Langsung ke konten utama
PATCH
/
workspaces
/
{workspaceId}
/
organizations
/
{organizationId}
Perbarui organisasi
curl --request PATCH \
  --url https://api.altostrat.io/workspaces/{workspaceId}/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Tim Pemasaran Global",
  "billing_account_id": "cus_a1b2c3d4e5f6g7h8",
  "limits": {
    "users": 100,
    "locations": null
  },
  "picture": "https://example.com/new_logo.png",
  "branding": {
    "display_name": "ACME Inc.",
    "login_hint": "acme-inc",
    "colors": {
      "primary": "#007bff"
    }
  }
}'
{
  "id": "org_aBcDeFg123456789",
  "name": "Departemen Teknik",
  "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

Masukkan JWT Anda dalam format: Bearer {token}

Path Parameters

โ€‹
workspaceId
string
required

ID dari workspace.

Example:

"ws_a1b2c3d4e5f6g7h8"

โ€‹
organizationId
string
required

ID dari organisasi.

Example:

"org_aBcDeFg123456789"

Body

application/json

Sediakan satu atau lebih bidang untuk diperbarui. Bidang yang tidak disediakan akan dibiarkan tidak berubah.

โ€‹
name
string

Nama baru untuk organisasi. Maksimal 50 karakter.

Example:

"Tim Pemasaran Global"

โ€‹
billing_account_id
string

ID dari akun penagihan yang akan dikaitkan dengan organisasi root.

Example:

"cus_a1b2c3d4e5f6g7h8"

โ€‹
limits
object

Perbarui batasan sumber daya. Untuk menghapus batasan, berikan kunci dengan nilai null.

Example:
{ "users": 100, "locations": null }
โ€‹
picture
string | null

URL HTTPS publik atau URI data base64 untuk logo baru. Untuk menghapus logo, berikan null.

Example:

"https://example.com/new_logo.png"

โ€‹
branding
object

Pengaturan branding untuk organisasi.

Response

Objek organisasi yang telah diperbarui.

โ€‹
id
string

Pengidentifikasi unik untuk organisasi (sesuai dengan ID organisasi Auth0), diawali dengan org_.

Example:

"org_aBcDeFg123456789"

โ€‹
name
string

Nama organisasi yang dapat dibaca manusia.

Example:

"Departemen Teknik"

โ€‹
workspace_id
string

ID dari workspace tempat organisasi ini berada.

Example:

"ws_a1b2c3d4e5f6g7h8"

โ€‹
external_id
string<uuid>

Pengidentifikasi unik yang stabil untuk organisasi, independen dari ID Auth0-nya.

Example:

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

โ€‹
parent_org_id
string | null

ID dari organisasi induk, jika ini adalah organisasi anak.

Example:

"org_zYxWvUt987654321"

โ€‹
path
string | null

String yang dipisahkan oleh # yang mewakili jalur hierarkis dari leluhur.

Example:

"org_root123#org_parent456"

โ€‹
depth
integer

Kedalaman organisasi dalam hierarki (0 untuk tingkat teratas).

Example:

2

โ€‹
billing_account_id
string | null

ID dari akun penagihan yang terkait dengan organisasi ini (dalam mode assigned).

Example:

"cus_a1b2c3d4e5f6g7h8"

โ€‹
picture
string<uri> | null

URL ke logo organisasi.

Example:

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

โ€‹
usage
object
โ€‹
limits
object

Peta batasan sumber daya yang diterapkan langsung ke organisasi ini. Kuncinya adalah jenis yang dapat diukur (locations, users, sso). Nilai null atau kunci yang hilang berarti tidak ada batasan yang ditetapkan pada tingkat ini. Nilai 0 berarti sumber daya secara eksplisit dinonaktifkan.

Example:
{ "locations": 10, "users": 50 }
โ€‹
branding
object