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

API referansı: Kuruluşlar

warning

Bir tenantı silmek, tüm süreçlerini, 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 tenantı silemezsiniz.

warning

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

Kuruluşlar, birden fazla tenantı tek bir varlık altında gruplandırır.

Tenantın kuruluşunu alın

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

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

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

Parametreler:

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

Yanıt (200):

Kuruluş ayrıntıları

{
	"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 Gerekli 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 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

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

Kuruluş genelinde her düzey için satın alınan ve kullanılan kullanıcı lisanslarını (Process Foundation, Process Architecture, Process Intelligence), ücretsiz Viewer hakkını, otomatik senkronizasyon hedefini, kullanıcı lisansı farkı açıklamasını (motorun ne zaman ne yapacağını), faturalandırma aralığını ve externalApiSeatPolicy değerini döndürür. Tenant kapsamlı bir API anahtarıyla okunabilir. {tenantId} yol parametresi bağlam tenantıdır (kuruluş kapsamlı anahtarın kuruluşu), işlemin hedefi değildir.

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

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

Parametreler:

Ad Tür Konum Gerekli Açıklama
tenantId string path 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,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 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
totalBillable number Evet
freeViewerAllowance number Evet
freeViewerOverAllowance 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 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 404 Kaynak bulunamadı

Kuruluş genelindeki istatistikleri alın

{tenantId} yol parametresi bağlam tenantıdır (kuruluş kapsamlı anahtarın kuruluşu), işlemin hedefi değildir.

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

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

Parametreler:

Ad Tür Konum Gerekli Açıklama
tenantId string path 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 Gerekli Açıklama
userCount number Evet
tenantCount number Evet
tenantStatistics object[] Evet

Hatalar:

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

Kuruluştaki tüm tenantları listeleyin

{tenantId} yol parametresi bağlam tenantıdır (kuruluş kapsamlı anahtarın kuruluşu), işlemin hedefi değildir.

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

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

Parametreler:

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

Yanıt (200):

Tenant 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
		},
		"url": "string"
	}
]

Hatalar:

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

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

{tenantId} yol parametresi bağlam tenantıdır (kuruluş kapsamlı anahtarın kuruluşu), işlemin hedefi değildir.

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

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

Parametreler:

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

İstek gövdesi:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string"
}
Alan Tür Gerekli Açıklama
displayName string Hayır Maksimum uzunluk: 128
shortName string Evet
description string Hayır Maksimum uzunluk: 200

Yanıt (201):

Tenant 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
	},
	"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: ""
Maksimum uzunluk: 128
contactEmail string Evet Biçim: email
isActive boolean Evet Varsayılan: true
shortName string Evet
useOrganizationTheme boolean Evet Varsayılan: true
description string Evet Maksimum uzunluk: 200
organizationId string Evet Biçim: uuid
allowedLogins object Evet
url string Evet Biçim: uri

Hatalar:

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

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

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

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

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

Parametreler:

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

Yanıt (200):

Tenant silindi

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

Hatalar:

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

Kuruluşta geçici olarak silinen bir tenantı geri yükleyin (kuruluş kapsamlı API anahtarı gerekir)

Silme güvenliği süresi içinde geçici silme işlemini geri alın: tenant ve verileri önceki haliyle geri gelir, API erişimi yeniden açılır. {tenantId} yol parametresi bağlam tenantıdır (kuruluş kapsamlı anahtarın kuruluşu), işlemin hedefi değildir.

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

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

Parametreler:

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

Yanıt (200):

Tenant geri yüklendi

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

Hatalar:

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

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

{tenantId} yol parametresi bağlam tenantıdır (kuruluş kapsamlı anahtarın kuruluşu), işlemin hedefi değildir.

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

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

Parametreler:

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

Yanıt (200):

Kuruluş kullanıcıları 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 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı

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

Gövde içindeki rol işaretleri (isAdminInOrganization, isActiveInOrganization) olduğu gibi uygulanır; kuruluş kapsamlı anahtarları yalnızca kuruluş yöneticilerine verin. {tenantId} yol parametresi bağlam tenantıdır (kuruluş kapsamlı anahtarın kuruluşu), işlemin hedefi değildir.

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

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

Parametreler:

Ad Tür Konum Gerekli 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 Gerekli Açıklama
isActiveInOrganization boolean Hayır Kullanıcının kuruluşta etkin olup olmadığı
isAdminInOrganization boolean Hayır Kuruluş yöneticisi hakları (olduğu gibi uygulanır: kuruluş kapsamlı anahtarları yalnızca kuruluş yöneticilerine verin)

Yanıt (200):

Güncellendi

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

Hatalar:

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

Bir kullanıcıyı kuruluştan kaldırın (kuruluş kapsamlı API anahtarı gerekir)

{tenantId} yol parametresi bağlam tenantıdır (kuruluş kapsamlı anahtarın kuruluşu), işlemin hedefi değildir.

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

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

Parametreler:

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

Yanıt (200):

Kullanıcı kaldırıldı

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

Hatalar:

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

İlgili dokümantasyon