Bu sayfada
> kaynaklar > belgeler > api > API referansı: kuruluşlar

API referansı: kuruluşlar

warning

Bir kiracıyı silmek, kiracıdaki tüm süreçleri, veri setlerini ve kullanıcı atamalarını kalıcı olarak kaldırır. Bu işlem geri alınamaz. Kimlik doğrulaması için kullandığınız kiracıyı silemezsiniz.

warning

Bir kullanıcıyı kuruluştan kaldırdığınızda, kuruluş içindeki tüm kiracılara erişimi iptal edilir.

Kuruluşlar, birden fazla kiracıyı tek bir yapı altında toplar.

Kiracının bağlı olduğu kuruluşu alın

Kiracı kapsamlı API anahtarıyla okunabilir; kuruluş kapsamlı anahtar da kabul edilir.

Uç nokta: GET /v1/tenant/{tenantId}/organization

Kimlik doğrulama: Kiracı veya kuruluş kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid

Yanıt (200):

Kuruluş bilgileri

{
	"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"
}
Alan Tür Zorunlu Açıklama
id string Evet Biçim: uuid
displayName string Evet Varsayılan: ""
Maksimum uzunluk: 128
createdAt string Evet Biçim: date-time
contactEmail string Evet Biçim: email
isActive boolean Evet Varsayılan: true
allowedLogins object Evet
createdBy string Evet Biçim: uuid

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 404 Kaynak bulunamadı

Kuruluşun kullanıcı lisansı kapasitesini ve otomatik eşitleme politikasını alın

Kuruluş genelinde her düzey (Process Foundation, Process Architecture, Process Intelligence) için satın alınan ve kullanılan kullanıcı lisansı sayılarını, ücretsiz görüntüleyici hakkını, otomatik eşitleme hedefini, lisans farkı açıklamasını (sistemin ne yapacağını ve ne zaman yapacağını), faturalandırma aralığını ve externalApiSeatPolicy değerini döndürür. Kiracı kapsamlı API anahtarıyla okunabilir. {tenantId} yol parametresi, işlemin hedefini değil bağlam kiracısını (kuruluş kapsamlı anahtarın ait olduğu kuruluşu) belirtir.

Uç nokta: GET /v1/tenant/{tenantId}/organization/billing/seats

Kimlik doğrulama: Kiracı veya kuruluş kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid

Yanıt (200):

Kullanıcı lisansı kapasitesi

{
	"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"
}
Alan Tür Gerekli Açıklama
contractType free | selfServe | fixed | unlimited Evet İzin verilen değerler: free, selfServe, fixed, unlimited
isTrial boolean Evet
purchased object Evet
inUseBillable object Evet
inUseFree number Evet
inUseDashboardViewers number Evet
totalBillable number Evet
freeViewerAllowance number Evet
freeViewerOverAllowance number Evet
dashboardViewerAllowance number Evet
dashboardViewerOverAllowance number Evet
fixedOverage number Evet
target object Evet
drift object[] Evet
interval month | year Evet İzin verilen değerler: month, year
nextBilledAt string Evet
externalApiSeatPolicy autoBill | requireCapacity Evet İzin verilen değerler: autoBill, requireCapacity

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 404 Kaynak bulunamadı

Kuruluş istatistiklerini alın

{tenantId} yol parametresi, işlemin hedefini değil bağlam kiracısını (kuruluş kapsamlı anahtarın ait olduğu kuruluşu) belirtir.

Uç nokta: GET /v1/tenant/{tenantId}/organization/statistics

Kimlik doğrulama: Kuruluş kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid

Yanıt (200):

Kuruluş istatistikleri

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}
Alan Tür Zorunlu Açıklama
userCount number Evet
tenantCount number Evet
tenantStatistics object[] Evet

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş

Kuruluştaki tüm kiracıları listeleyin

{tenantId} yol parametresi, işlemin hedefini değil bağlam kiracısını (kuruluş kapsamlı anahtarın ait olduğu kuruluşu) belirtir.

Uç nokta: GET /v1/tenant/{tenantId}/organization/tenants

Kimlik doğrulama: Kuruluş kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid
limit integer sorgu Hayır Döndürülecek en fazla öğe sayısı
offset integer sorgu Hayır Atlanacak öğe sayısı

Yanıt (200):

Kiracı listesi

[
	{
		"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"
	}
]

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş

Kuruluşta yeni kiracı oluşturun (kuruluş kapsamlı API anahtarı gerekir)

{tenantId} yol parametresi, işlemin hedefini değil bağlam kiracısını (kuruluş kapsamlı anahtarın ait olduğu kuruluşu) belirtir.

Uç nokta: POST /v1/tenant/{tenantId}/organization/tenants

Kimlik doğrulama: Kuruluş kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid

İstek gövdesi:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}
Alan Tür Gerekli Açıklama
displayName string Hayır En fazla 128 karakter
shortName string Evet
description string Hayır En fazla 200 karakter
timezone string Hayır En fazla 64 karakter
tenantType normal | sandbox | demo Hayır İzin verilen değerler: normal, sandbox, demo

Yanıt (201):

Kiracı oluşturuldu

{
	"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"
}
Alan Tür Gerekli Açıklama
id string Evet Biçim: uuid
createdBy string Evet Biçim: uuid
createdAt string Evet Biçim: date-time
displayName string Evet Varsayılan: ""
En fazla 128 karakter
contactEmail string Evet Biçim: email
isActive boolean Evet Varsayılan: true
shortName string Evet
useOrganizationTheme boolean Evet Varsayılan: true
description string Evet En fazla 200 karakter
organizationId string Evet Biçim: uuid
allowedLogins object Evet
tenantType normal | sandbox | demo Evet İzin verilen değerler: normal, sandbox, demo
Varsayılan: normal
url string Evet Biçim: uri

Hatalar:

  • 400 Hatalı istek: ör. geçersiz filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen yükleme türü veya zorunlu bir alanın eksik olması
  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü desteklemiyor
  • 406 Değer kabul edilemiyor (ör. ayrılmış veya yinelenen kısa ad)

Kuruluştaki bir kiracıyı geçici olarak silin (kuruluş kapsamlı API anahtarı gerekir)

Kiracının API erişimi hemen durdurulur. Kiracı ve verileri, silme güvenlik süresi boyunca saklanır ve ardından otomatik kalıcı silme işlemiyle kaldırılır. Şu anda kullandığınız kiracı (bağlam kiracısı) silinemez.

Uç nokta: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

Kimlik doğrulama: Kuruluş kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
targetId string path Evet Biçim: uuid

Yanıt (200):

Kiracı silindi

{
	"success": true,
	"message": "string"
}
Alan Tür Zorunlu Açıklama
success boolean Evet
message string Evet

Hatalar:

  • 400 Hatalı istek: ör. geçersiz filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen yükleme türü veya zorunlu bir alanın eksik olması
  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü desteklemiyor
  • 404 Kaynak bulunamadı

Kuruluştaki geçici olarak silinmiş bir kiracıyı geri yükleyin (kuruluş kapsamlı API anahtarı gerekir)

Silme güvenlik süresi içinde geçici silme işlemini geri alın: kiracı ve verileri önceki hâline döner, API erişimi yeniden başlar. {tenantId} yol parametresi, işlemin hedefini değil bağlam kiracısını (kuruluş kapsamlı anahtarın kuruluşunu) belirtir.

Uç nokta: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

Kimlik doğrulama: Kuruluş kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
targetId string path Evet Biçim: uuid

Yanıt (200):

Kiracı geri yüklendi

{
	"success": true,
	"message": "string"
}
Alan Tür Zorunlu Açıklama
success boolean Evet
message string Evet

Hatalar:

  • 400 Hatalı istek: ör. geçersiz filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen yükleme türü veya zorunlu bir alanın eksik olması
  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü desteklemiyor
  • 404 Kaynak bulunamadı

Kuruluştaki tüm kullanıcıları listeleyin

{tenantId} yol parametresi, işlemin hedefini değil bağlam kiracısını (kuruluş kapsamlı anahtarın kuruluşunu) belirtir.

Uç nokta: GET /v1/tenant/{tenantId}/organization/users

Kimlik doğrulama: Kuruluş kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
limit integer query Hayır Döndürülecek en fazla öğe sayısı
offset integer query Hayır Atlanacak öğe sayısı

Yanıt (200):

Kuruluş kullanıcılarının listesi

[
	{
		"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
	}
]

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş

Kuruluş kullanıcısının ayarlarını güncelleyin (kuruluş kapsamlı API anahtarı gerekir)

İstek gövdesindeki rol bayrakları (isAdminInOrganization, isActiveInOrganization) aynen uygulanır. Kuruluş kapsamlı anahtarları yalnızca kuruluş yöneticilerine verin. {tenantId} yol parametresi, işlemin hedefini değil bağlam kiracısını (kuruluş kapsamlı anahtarın kuruluşunu) belirtir.

Uç nokta: PUT /v1/tenant/{tenantId}/organization/users/{userId}

Kimlik doğrulama: Kuruluş kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
userId string path Evet Biçim: uuid

İstek gövdesi:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}
Alan Tür Zorunlu Açıklama
isActiveInOrganization boolean Hayır Kullanıcının kuruluşta etkin olup olmadığı
isAdminInOrganization boolean Hayır Kuruluş yöneticisi yetkileri (aynen uygulanır: kuruluş kapsamlı anahtarları yalnızca kuruluş yöneticilerine verin)

Yanıt (200):

Güncellendi

{
	"message": "string"
}
Alan Tür Zorunlu Açıklama
message string Evet

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü desteklemiyor
  • 404 Kaynak bulunamadı

Bir kullanıcıyı kuruluştan çıkarın (kuruluş kapsamlı API anahtarı gerekir)

{tenantId} yol parametresi, işlemin hedefini değil bağlam kiracısını (kuruluş kapsamlı anahtarın kuruluşunu) belirtir.

Uç nokta: DELETE /v1/tenant/{tenantId}/organization/users/{userId}

Kimlik doğrulama: Kuruluş kapsamlı API anahtarı · write kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string path Evet Biçim: uuid
userId string path Evet Biçim: uuid

Yanıt (200):

Kullanıcı çıkarıldı

{
	"message": "string"
}
Alan Tür Zorunlu Açıklama
message string Evet

Hatalar:

  • 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
  • 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü desteklemiyor
  • 404 Kaynak bulunamadı

İlgili dokümantasyon

Süreçlerinizi daha iyi tasarlayın. Bağlantılı bir mimari kurun. Kontrolü elinizde tutun.

Kredi kartı gerekmeden, beklemeden hemen erişin. Kuruluşunuzdaki çalışma biçimini net ve birbiriyle bağlantılı süreç tasarımlarına dönüştürün.

Süreç mimarinizi oluşturun, sahiplik ve kontrolleri tanımlayın; rol ve sorumlulukları her düzeyde uyumlu hâle getirin.

Ücretsiz denemeyi başlatın; süreçlerinizi yönetmek ve sürekli iyileştirmek için güvenilir bir temel oluşturun.

Ücretsiz denemeyi başlatın