Di halaman ini

> sumber daya > dokumentasi > api > Referensi API: Organisasi

Referensi API: Organisasi

warning

Menghapus tenant akan menghapus secara permanen semua proses, dataset, dan penetapan penggunanya. Tindakan ini tidak dapat dibatalkan. Anda tidak dapat menghapus tenant yang digunakan untuk autentikasi.

warning

Menghapus pengguna dari organisasi akan mencabut aksesnya ke semua tenant dalam organisasi tersebut.

Organisasi mengelompokkan beberapa tenant dalam satu entitas.

Dapatkan organisasi untuk tenant

Endpoint ini dapat diakses dengan API key bercakupan tenant. API key bercakupan organisasi juga dapat digunakan.

Endpoint: GET /v1/tenant/{tenantId}/organization

Autentikasi: API key bercakupan tenant atau organisasi · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`

Respons (200):

Detail organisasi

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"contactEmail": "string",
	"isActive": true,
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: `uuid`
displayName	string	Ya	Default: `""` Panjang maksimum: 128
createdAt	string	Ya	Format: `date-time`
contactEmail	string	Ya	Format: `email`
isActive	boolean	Ya	Default: `true`
allowedLogins	object	Ya
createdBy	string	Ya	Format: `uuid`

Error:

401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
404 Sumber daya tidak ditemukan

Lihat kapasitas lisensi dan kebijakan sinkronisasi otomatis organisasi

Menampilkan jumlah lisensi yang dibeli dan sedang digunakan di seluruh organisasi untuk setiap tingkat (Process Foundation, Process Architecture, Process Intelligence), kuota Viewer gratis, target sinkronisasi otomatis, penjelasan selisih lisensi (tindakan yang akan dilakukan sistem dan waktunya), interval penagihan, serta externalApiSeatPolicy. Endpoint ini dapat diakses dengan API key bercakupan tenant. Parameter path {tenantId} menunjukkan tenant konteks (organisasi dari API key bercakupan organisasi), bukan sasaran operasi.

Endpoint: GET /v1/tenant/{tenantId}/organization/billing/seats

Autentikasi: API key bercakupan tenant atau organisasi · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`

Respons (200):

Kapasitas lisensi

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"inUseDashboardViewers": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"dashboardViewerAllowance": 0,
	"dashboardViewerOverAllowance": 0,
	"fixedOverage": 0,
	"target": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"drift": [
		{
			"rung": "foundation",
			"paid": 0,
			"actual": 0,
			"state": "equal",
			"buffer": 0
		}
	],
	"interval": "month",
	"nextBilledAt": "string",
	"externalApiSeatPolicy": "autoBill"
}

Kolom	Tipe	Wajib	Deskripsi
contractType	`free` \| `selfServe` \| `fixed` \| `unlimited`	Ya	Nilai yang diizinkan: `free`, `selfServe`, `fixed`, `unlimited`
isTrial	boolean	Ya
purchased	object	Ya
inUseBillable	object	Ya
inUseFree	number	Ya
inUseDashboardViewers	number	Ya
totalBillable	number	Ya
freeViewerAllowance	number	Ya
freeViewerOverAllowance	number	Ya
dashboardViewerAllowance	number	Ya
dashboardViewerOverAllowance	number	Ya
fixedOverage	number	Ya
target	object	Ya
drift	object[]	Ya
interval	`month` \| `year`	Ya	Nilai yang diizinkan: `month`, `year`
nextBilledAt	string	Ya
externalApiSeatPolicy	`autoBill` \| `requireCapacity`	Ya	Nilai yang diizinkan: `autoBill`, `requireCapacity`

Error:

401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
404 Sumber daya tidak ditemukan

Lihat statistik seluruh organisasi

Parameter path {tenantId} menunjukkan tenant konteks (organisasi dari API key bercakupan organisasi), bukan sasaran operasi.

Endpoint: GET /v1/tenant/{tenantId}/organization/statistics

Autentikasi: API key bercakupan organisasi · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`

Respons (200):

Statistik organisasi

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}

Kolom	Tipe	Wajib
userCount	number	Ya
tenantCount	number	Ya
tenantStatistics	object[]	Ya

Error:

401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa

Tampilkan semua tenant dalam organisasi

Parameter path {tenantId} menunjukkan tenant konteks (organisasi dari API key bercakupan organisasi), bukan sasaran operasi.

Endpoint: GET /v1/tenant/{tenantId}/organization/tenants

Autentikasi: API key bercakupan organisasi · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`
limit	integer	query	Tidak	Jumlah maksimum item yang ditampilkan
offset	integer	query	Tidak	Jumlah item yang dilewati

Respons (200):

Daftar tenant

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"createdBy": "00000000-0000-0000-0000-000000000000",
		"createdAt": "2024-03-15T16:30:00Z",
		"displayName": "string",
		"contactEmail": "string",
		"isActive": true,
		"shortName": "string",
		"useOrganizationTheme": true,
		"description": "string",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"allowedLogins": {
			"Microsoft": true,
			"Google": true,
			"LinkedIn": true
		},
		"tenantType": "normal",
		"url": "string"
	}
]

Error:

401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa

Buat tenant baru dalam organisasi (memerlukan API key bercakupan organisasi)

Parameter path {tenantId} menunjukkan tenant konteks (organisasi dari API key bercakupan organisasi), bukan sasaran operasi.

Endpoint: POST /v1/tenant/{tenantId}/organization/tenants

Autentikasi: API key bercakupan organisasi · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`

Isi permintaan:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}

Kolom	Tipe	Wajib	Deskripsi
displayName	string	Tidak	Panjang maksimum: 128
shortName	string	Ya
description	string	Tidak	Panjang maksimum: 200
timezone	string	Tidak	Panjang maksimum: 64
tenantType	`normal` \| `sandbox` \| `demo`	Tidak	Nilai yang diizinkan: `normal`, `sandbox`, `demo`

Respons (201):

Tenant dibuat

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}

Kolom	Tipe	Wajib	Deskripsi
id	string	Ya	Format: `uuid`
createdBy	string	Ya	Format: `uuid`
createdAt	string	Ya	Format: `date-time`
displayName	string	Ya	Default: `""` Panjang maksimum: 128
contactEmail	string	Ya	Format: `email`
isActive	boolean	Ya	Default: `true`
shortName	string	Ya
useOrganizationTheme	boolean	Ya	Default: `true`
description	string	Ya	Panjang maksimum: 200
organizationId	string	Ya	Format: `uuid`
allowedLogins	object	Ya
tenantType	`normal` \| `sandbox` \| `demo`	Ya	Nilai yang diizinkan: `normal`, `sandbox`, `demo` Default: `normal`
url	string	Ya	Format: `uri`

Error:

400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan tidak didukung, atau kolom wajib tidak diisi
401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
403 API key tidak memiliki cakupan atau akses organisasi yang diperlukan, tenant tidak aktif, atau paket tidak mengizinkan jenis file tersebut
406 Nilai tidak dapat diterima, misalnya nama singkat yang dicadangkan atau sudah digunakan

Hapus sementara tenant dalam organisasi (memerlukan API key bercakupan organisasi)

Akses API untuk tenant langsung dihentikan. Tenant dan datanya disimpan selama masa pengamanan penghapusan, lalu dihapus sepenuhnya secara otomatis. Tenant yang sedang Anda gunakan (tenant konteks) tidak dapat dihapus.

Endpoint: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

Autentikasi: API key bercakupan organisasi · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`
targetId	string	path	Ya	Format: `uuid`

Respons (200):

Tenant dihapus

{
	"success": true,
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
success	boolean	Ya
message	string	Ya

Error:

400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan tidak didukung, atau kolom wajib tidak diisi
401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
403 API key tidak memiliki cakupan atau akses organisasi yang diperlukan, tenant tidak aktif, atau paket tidak mengizinkan jenis file tersebut
404 Sumber daya tidak ditemukan

Pulihkan tenant yang dihapus sementara dalam organisasi (memerlukan API key bercakupan organisasi)

Batalkan penghapusan sementara selama masa pengamanan penghapusan: tenant dan datanya akan kembali persis seperti semula, dan akses API akan aktif kembali. Parameter path {tenantId} menunjukkan tenant konteks (organisasi dari API key bercakupan organisasi), bukan sasaran operasi.

Endpoint: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

Autentikasi: API key bercakupan organisasi · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`
targetId	string	path	Ya	Format: `uuid`

Respons (200):

Tenant dipulihkan

{
	"success": true,
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
success	boolean	Ya
message	string	Ya

Error:

400 Permintaan tidak valid, misalnya ekspresi filter tidak valid, proses tanpa model, jenis unggahan tidak didukung, atau kolom wajib tidak diisi
401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
403 API key tidak memiliki cakupan atau akses organisasi yang diperlukan, tenant tidak aktif, atau paket tidak mengizinkan jenis file tersebut
404 Sumber daya tidak ditemukan

Tampilkan semua pengguna dalam organisasi

Parameter path {tenantId} menunjukkan tenant konteks (organisasi dari API key bercakupan organisasi), bukan sasaran operasi.

Endpoint: GET /v1/tenant/{tenantId}/organization/users

Autentikasi: API key bercakupan organisasi · cakupan read

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`
limit	integer	query	Tidak	Jumlah maksimum item yang ditampilkan
offset	integer	query	Tidak	Jumlah item yang dilewati

Respons (200):

Daftar pengguna organisasi

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

Error:

401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa

Perbarui pengaturan pengguna organisasi (memerlukan API key bercakupan organisasi)

Flag peran dalam isi permintaan (isAdminInOrganization, isActiveInOrganization) diterapkan persis seperti yang dikirim. Berikan API key bercakupan organisasi hanya kepada admin organisasi. Parameter path {tenantId} menunjukkan tenant konteks (organisasi dari API key bercakupan organisasi), bukan sasaran operasi.

Endpoint: PUT /v1/tenant/{tenantId}/organization/users/{userId}

Autentikasi: API key bercakupan organisasi · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`
userId	string	path	Ya	Format: `uuid`

Isi permintaan:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}

Kolom	Tipe	Wajib	Deskripsi
isActiveInOrganization	boolean	Tidak	Menentukan apakah pengguna aktif di organisasi
isAdminInOrganization	boolean	Tidak	Hak admin organisasi (diterapkan persis seperti yang dikirim: berikan API key bercakupan organisasi hanya kepada admin organisasi)

Respons (200):

Diperbarui

{
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
message	string	Ya

Error:

401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
403 API key tidak memiliki cakupan atau akses organisasi yang diperlukan, tenant tidak aktif, atau paket tidak mengizinkan jenis file tersebut
404 Sumber daya tidak ditemukan

Hapus pengguna dari organisasi (memerlukan API key bercakupan organisasi)

Parameter path {tenantId} menunjukkan tenant konteks (organisasi dari API key bercakupan organisasi), bukan sasaran operasi.

Endpoint: DELETE /v1/tenant/{tenantId}/organization/users/{userId}

Autentikasi: API key bercakupan organisasi · cakupan write

Parameter:

Nama	Tipe	Lokasi	Wajib	Deskripsi
tenantId	string	path	Ya	Format: `uuid`
userId	string	path	Ya	Format: `uuid`

Respons (200):

Pengguna dihapus

{
	"message": "string"
}

Kolom	Tipe	Wajib	Deskripsi
message	string	Ya

Error:

401 API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
403 API key tidak memiliki cakupan atau akses organisasi yang diperlukan, tenant tidak aktif, atau paket tidak mengizinkan jenis file tersebut
404 Sumber daya tidak ditemukan

Dokumentasi terkait

Referensi API: Tenant

Referensi API untuk endpoint pengelolaan tenant dan kontrol akses pengguna.

Referensi API: Data

Referensi API untuk endpoint pengelolaan dataset dan datatable.

Referensi API: Proses

Referensi API untuk endpoint pengelolaan proses dan pemetaan data.

Referensi API: Simulasi

Referensi API untuk pengelolaan simulasi dan endpoint pembuatan berbantuan AI.

Rancang proses yang lebih baik. Bangun arsitektur yang saling terhubung. Tetap kendalikan semuanya.

Mulai sekarang juga tanpa kartu kredit dan tanpa perlu menunggu. Ubah cara kerja organisasi Anda menjadi rancangan proses yang jelas dan saling terhubung.

Bangun arsitektur proses, tetapkan penanggung jawab dan kontrol, lalu selaraskan peran serta tanggung jawab di setiap tingkat.

Mulai uji coba gratis dan bangun satu landasan tepercaya untuk mengatur, mengelola, dan terus memperbaiki proses Anda.

Mulai uji coba gratis hari ini