API referansı: Kiracılar

Kiracı bilgilerini alın

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

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

Parametreler:

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

Yanıt (200):

Kiracı ayrıntıları

{
	"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:

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

Kiracı ayarlarını güncelleyin

Uç nokta: PUT /v1/tenant/{tenantId}

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

Parametreler:

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

İstek gövdesi:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"contactEmail": "string",
	"shortName": "string",
	"description": "string"
}

Alan	Tür	Zorunlu	Açıklama
id	string	Hayır	Biçim: uuid
displayName	string	Hayır
contactEmail	string	Hayır
shortName	string	Hayır
description	string	Hayır

Yanıt (200):

Güncellenmiş kiracı

{
	"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: geçersiz filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen yükleme türü veya eksik zorunlu alan gibi
• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 403 API anahtarının gerekli kapsamı veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü engelliyor
• 406 Değer kabul edilemiyor (ör. ayrılmış veya yinelenen kısa ad)

Kiracı istatistiklerini alın (veri boyutu, modeller, simülasyonlar, kullanıcılar)

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

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

Parametreler:

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

Yanıt (200):

Kiracı istatistikleri

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

Alan	Tür	Zorunlu	Açıklama
tenantId	string	Evet	Biçim: uuid
uploadedDataSize	number	Evet
uploadedDataCount	number	Evet
modelCount	number	Evet
simulationCount	number	Evet
userCount	number	Evet

Hatalar:

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

Kiracıdaki kullanıcıları listeleyin

Eşleşen kullanıcılar doğrudan JSON dizisi olarak döndürülür; toplam kayıt sayısı verilmez. Sayfalama için limit/offset kullanın.

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

Kimlik doğrulama: Kiracı 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):

Kullanıcı 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",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"isActiveInTenant": true,
		"isAdminInTenant": true,
		"access": "none",
		"isDashboardViewer": true,
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

Hatalar:

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

Kiracıya kullanıcı ekleyin (davet e-postası gönderilmez)

İstek gövdesindeki rol alanları (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) aynen uygulanır. Bu uç nokta, kiracı yöneticisinin tüm işlemlerine erişim sağlar. Bu nedenle yazma kapsamlı anahtarları yalnızca güvenilir çağrılara verin. Dashboard görüntüleme yetkisi isDashboardViewer boolean alanıyla belirlenir; eski salt okunur görüntüleyici kademesi kaldırılmıştır.

Uç nokta: POST /v1/tenant/{tenantId}/users

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

Parametreler:

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

İstek gövdesi:

{
	"email": "string",
	"firstName": "string",
	"lastName": "string",
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true,
	"preferredLocale": "en"
}

Alan	Tür	Gerekli	Açıklama
email	string	Evet	Kullanıcının e-posta adresi (aynı zamanda giriş kimliği) Biçim: email
firstName	string	Hayır	İsteğe bağlı ad En fazla 64 karakter
lastName	string	Hayır	İsteğe bağlı soyadı En fazla 64 karakter
isActiveInTenant	boolean	Hayır	Kullanıcının bu kiracıda etkin olup olmadığı
isAdminInTenant	boolean	Hayır	Bu kiracıdaki yönetici hakları (aynen uygulanır: kiracı yöneticisinin tüm yetkileri)
access	none | portalViewer | designer | architect | intelligence	Hayır	Tek seçimli kullanıcı lisansı: none | portalViewer | designer | architect | intelligence İzin verilen değerler: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	Hayır	Kullanıcının Dashboardları salt okunur olarak görüntüleyip görüntüleyemeyeceği
preferredLocale	en | zh | es | fr | de | pt | it | nl | ja | tr | pl | cs | hu | id | ko | vi | th	Hayır	Kullanıcının tercih ettiği arayüz dili İzin verilen değerler: en, zh, es, fr, de, pt, it, nl, ja, tr, pl, cs, hu, id, ko, vi, th

Yanıt (201):

Kullanıcı eklendi

{
	"id": "string",
	"message": "string"
}

Alan	Tür	Zorunlu	Açıklama
id	string	Evet	Yeni eklenen kullanıcının kimliği
message	string	Evet

Hatalar:

• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 409 İstek mevcut durumla çakışıyor (ör. kullanıcı lisansı sınırı veya yinelenen kimlik)

Kullanıcının kiracı ayarlarını güncelleyin

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

Kimlik doğrulama: Kiracı 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:

{
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true
}

Alan	Tür	Zorunlu	Açıklama
isActiveInTenant	boolean	Hayır	Kullanıcının bu kiracıda etkin olup olmadığı
isAdminInTenant	boolean	Hayır	Bu kiracıdaki yönetici yetkileri (aynen uygulanır: kiracı yöneticisinin tüm işlemlerine erişim)
access	none | portalViewer | designer | architect | intelligence	Hayır	Tek seçimli kullanıcı lisansı: none | portalViewer | designer | architect | intelligence. Dashboard görüntüleme yetkisi isDashboardViewer boolean alanıyla belirlenir. İzin verilen değerler: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	Hayır	Kullanıcının Dashboardları salt okunur görüntüleme yetkisi olup olmadığı

Yanıt (200):

Güncellendi

{
	"message": "string"
}

Alan	Tür	Zorunlu	Açıklama
message	string	Evet

Hatalar:

• 400 Hatalı istek: geçersiz filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen yükleme türü veya eksik zorunlu alan gibi
• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 404 Kaynak bulunamadı

Kullanıcıyı kiracıdan kaldırın

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

Kimlik doğrulama: Kiracı 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ı kaldırıldı

{
	"message": "string"
}

Alan	Tür	Zorunlu	Açıklama
message	string	Evet

Hatalar:

• 400 Hatalı istek: geçersiz filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen yükleme türü veya eksik zorunlu alan gibi
• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 404 Kaynak bulunamadı

Kullanıcı için tek kullanımlık giriş devir teslim belirteci oluşturun

Kullanıcıya, kiracıya ve kuruluşa bağlı, 60 saniye geçerliliği olan tek kullanımlık bir belirteç ile kullanıcının tarayıcısını yönlendireceğiniz url döndürülür. URL’yi kullanıcının tarayıcısında açın; kullanıcı e-posta bağlantısına veya başka bir kullanıcı gibi oturum açmaya gerek kalmadan ProcessMind’de kendi oturumuyla giriş yapar. API anahtarında özel sessions kapsamı gerekir: kuruluş kapsamlı bir anahtar, kuruluşundaki tüm kiracılar için belirteç oluşturabilir; kiracı kapsamlı bir anahtar ise yalnızca kendi kiracısındaki kullanıcılar için oluşturabilir. Belirteci parola kadar hassas kabul edin: yalnızca bir kez döndürülür, hiçbir zaman günlüğe kaydedilmez ve anahtar veya kullanıcı devre dışı bırakıldığında geçersiz kılınır.

Uç nokta: POST /v1/tenant/{tenantId}/users/{userId}/login-token

Kimlik doğrulama: Kiracı veya kuruluş kapsamlı API anahtarı · sessions kapsamı · hız sınırı: saniyede 2 istek (ani artışta 4)

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:

İsteğe bağlı açılış yolu (göreli uygulama yolu; ör. “app” veya “app/dashboards”)

{
	"path": "string"
}

Alan	Tür	Zorunlu	Açıklama
path	string	Hayır	Maksimum uzunluk: 512

Yanıt (200):

Giriş devir teslim belirteci

{
	"token": "string",
	"url": "string",
	"expiresInSeconds": 0,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Alan	Tür	Zorunlu	Açıklama
token	string	Evet
url	string	Evet
expiresInSeconds	number	Evet
expiresAt	string	Evet	Biçim: date-time

Hatalar:

• 400 Hatalı istek: geçersiz filtre ifadesi, modeli olmayan bir süreç, desteklenmeyen yükleme türü veya eksik zorunlu alan gibi
• 401 API anahtarı eksik, geçersiz, devre dışı veya süresi dolmuş
• 403 API anahtarının gerekli kapsamı veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü engelliyor
• 404 Kaynak bulunamadı
• 429 İstek hız sınırı aşıldı: uç nokta için belgelenen hız sınırına bakın

API anahtarları entegrasyonlarınızın kimliğini doğrular. Kuruluş kapsamlı anahtarlar, kuruluştaki tüm kiracıların anahtarlarını oluşturabilir ve yönetebilir.

Kiracının API anahtarlarını listeleyin

Kuruluş kapsamlı bir API anahtarı gerekir. Gizli anahtar hiçbir zaman döndürülmez.

Uç nokta: GET /v1/tenant/{tenantId}/api-keys

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):

API anahtarları listesi

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"partialKey": "string",
		"enabled": true,
		"createdAt": "2024-03-15T16:30:00Z",
		"lastUsedAt": "2024-03-15T16:30:00Z",
		"expiresAt": "2024-03-15T16:30:00Z",
		"scope": {
			"read": true,
			"write": true,
			"uploadData": true,
			"sessions": true
		}
	}
]

Hatalar:

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

Kiracı kapsamlı API anahtarı oluşturun

Kuruluş kapsamlı bir yazma anahtarı gerekir. Gizli anahtar sunucu tarafında oluşturulur ve yanıtta yalnızca bir kez döndürülür; güvenli bir yerde saklayın. Yalnızca özeti saklanır.

Uç nokta: POST /v1/tenant/{tenantId}/api-keys

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",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Alan	Tür	Zorunlu	Açıklama
displayName	string	Evet	Maksimum uzunluk: 128
scope	object	Hayır
enabled	boolean	Hayır
expiresAt	string	Hayır	Biçim: date-time

Yanıt (201):

API anahtarı oluşturuldu (tek kullanımlık gizli anahtar yanıta dahildir)

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"secret": "string"
}

Alan	Tür	Zorunlu	Açıklama
id	string	Evet	Biçim: uuid
tenantId	string	Evet	Biçim: uuid
organizationId	string	Evet	Biçim: uuid
displayName	string	Evet	Maksimum uzunluk: 128
partialKey	string	Evet	Maksimum uzunluk: 128
enabled	boolean	Evet	Varsayılan: true
createdAt	string	Evet	Biçim: date-time
lastUsedAt	string	Evet	Biçim: date-time
expiresAt	string	Evet	Biçim: date-time
scope	object	Evet
secret	string	Evet	Maksimum uzunluk: 128

Hatalar:

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

Kiracı kapsamlı API anahtarını güncelleyin

Kuruluş kapsamlı bir yazma anahtarı gerekir. Kapsam alanları, kayıtlı kapsamla birleştirilir.

Uç nokta: PUT /v1/tenant/{tenantId}/api-keys/{keyId}

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

Parametreler:

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

İstek gövdesi:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Alan	Tür	Zorunlu	Açıklama
displayName	string	Hayır	Maksimum uzunluk: 128
scope	object	Hayır
enabled	boolean	Hayır
expiresAt	string	Hayır	Biçim: date-time

Yanıt (200):

API anahtarı güncellendi

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	}
}

Alan	Tür	Zorunlu	Açıklama
id	string	Evet	Biçim: uuid
tenantId	string	Evet	Biçim: uuid
organizationId	string	Evet	Biçim: uuid
displayName	string	Evet	Maksimum uzunluk: 128
partialKey	string	Evet	Maksimum uzunluk: 128
enabled	boolean	Evet	Varsayılan: true
createdAt	string	Evet	Biçim: date-time
lastUsedAt	string	Evet	Biçim: date-time
expiresAt	string	Evet	Biçim: date-time
scope	object	Evet

Hatalar:

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

Kiracı kapsamlı API anahtarını silin

Kuruluş kapsamlı bir yazma anahtarı gerekir. Anahtar mantıksal olarak silinir ve kimlik doğrulamada hemen kullanılamaz hale gelir.

Uç nokta: DELETE /v1/tenant/{tenantId}/api-keys/{keyId}

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

Parametreler:

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

Yanıt (200):

API anahtarı silindi

{
	"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ının gerekli kapsamı veya kuruluş erişimi yok, kiracı etkin değil ya da plan dosya türünü engelliyor
• 404 Kaynak bulunamadı