API referansı: Kuruluşlar

Kuruluş bilgilerini alın

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

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

Alan	Tür	Zorunlu	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:

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

Kuruluş ayarlarını güncelleyin

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

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

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	yol	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üncellenen kuruluş

{
	"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	Zorunlu	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, kuruluş etkin değil ya da plan dosya türünü engelliyor
• 406 Değer kabul edilemiyor (örneğin ayrılmış veya yinelenen kısa ad)

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

Uç nokta: GET /v1/tenant/{tenantId}/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

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

Kuruluştaki kullanıcıları listeleyin

Eşleşen kullanıcıları doğrudan JSON dizisi olarak döndürür: toplam sayı yoktur; limit/offset ile sayfalayın.

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

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

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

Kuruluşa kullanıcı ekleyin (davet e-postası gönderilmez)

Gövde içindeki rol alanları (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) olduğu gibi dikkate alınır; bu uç nokta tam kuruluş yöneticisi yetkileri sağladığından yalnızca güvenilir çağıranlara yazma kapsamlı anahtarlar verin. Dashboard görüntüleme, isDashboardViewer boolean alanıyla belirlenir; eski salt okunur görüntüleyici seviyesi kaldırılmıştır.

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

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

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	yol	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	Zorunlu	Açıklama
email	string	Evet	Kullanıcının e-posta adresi (giriş kimliği olarak da kullanılır) Biçim: email
firstName	string	Hayır	İsteğe bağlı ad Maksimum uzunluk: 64
lastName	string	Hayır	İsteğe bağlı soyadı Maksimum uzunluk: 64
isActiveInTenant	boolean	Hayır	Kullanıcının bu kuruluşta etkin olup olmadığı
isAdminInTenant	boolean	Hayır	Bu kuruluştaki yönetici hakları (olduğu gibi dikkate alınır: tam kuruluş yöneticisi 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 salt okunur Dashboard görüntüleme yetkisine sahip olup olmadığı
preferredLocale	en | zh | es | fr | de | pt | it | nl | ja | tr	Hayır	Kullanıcı için tercih edilen arayüz yereli İzin verilen değerler: en, zh, es, fr, de, pt, it, nl, ja, tr

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 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
• 409 İstek mevcut durumla çakışıyor (örneğin kullanıcı lisansı kısıtı veya yeniden kullanılan bir kimlik)

Kullanıcının kuruluş ayarlarını güncelleyin

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

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

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	yol	Evet	Biçim: uuid
userId	string	yol	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 kuruluşta etkin olup olmadığı
isAdminInTenant	boolean	Hayır	Bu kuruluştaki yönetici hakları (olduğu gibi dikkate alınır: tam kuruluş yöneticisi yetkileri)
access	none | portalViewer | designer | architect | intelligence	Hayır	Tek seçimli kullanıcı lisansı: none | portalViewer | designer | architect | intelligence. Dashboard görüntüleme, isDashboardViewer boolean alanıyla belirlenir. İzin verilen değerler: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	Hayır	Kullanıcının salt okunur Dashboard görüntüleme yetkisine sahip olup olmadığı

Yanıt (200):

Güncellendi

{
	"message": "string"
}

Alan	Tür	Zorunlu	Açıklama
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ı
• 404 Kaynak bulunamadı

Kullanıcıyı kuruluştan kaldırın

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

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

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	yol	Evet	Biçim: uuid
userId	string	yol	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: ö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ı
• 404 Kaynak bulunamadı

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

Kullanıcıya, kuruluşa ve organizasyona bağlı tek kullanımlık bir belirteç (60 saniye TTL) ile kullanıcının tarayıcısını yönlendireceğiniz url değerini döndürür. URLyi kullanıcının tarayıcısında açtığınızda kullanıcı ProcessMind’e kimliği doğrulanmış olarak girer: e-posta bağlantısı veya başka bir kullanıcı gibi davranma yoktur; kullanıcı kendi oturumunu açar. API anahtarında özel sessions kapsamı gerekir: organizasyon kapsamlı bir anahtar, organizasyonundaki tüm kuruluşlar için belirteç oluşturabilir; kuruluş kapsamlı bir anahtar ise yalnızca kendi kuruluşundaki kullanıcılar için oluşturabilir. Belirteci parola eşdeğeri olarak değerlendirin: yalnızca bir kez döndürülür, hiçbir zaman günlüğe yazılmaz ve anahtar veya kullanıcı devre dışı bırakılarak iptal edilir.

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

Kimlik doğrulama: Kuruluş veya organizasyon kapsamlı API anahtarı · sessions kapsamı · hız sınırı 2 istek/sn (ani artış 4)

Parametreler:

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

İstek gövdesi:

İsteğe bağlı açılış yolu (göreli uygulama yolu, örneğin “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: ö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, kuruluş etkin değil ya da plan dosya türünü engelliyor
• 404 Kaynak bulunamadı
• 429 Hız sınırı aşıldı: uç noktanın belgelenen hız sınırına bakın

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

Kuruluşun API anahtarlarını listeleyin

Bir organizasyon kapsamlı API anahtarı gerekir. Gizli değer hiçbir zaman döndürülmez.

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

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

API anahtarı 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 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
• 403 API anahtarında gerekli kapsam veya kuruluş erişimi yok, kuruluş etkin değil ya da plan dosya türünü engelliyor

Kuruluş kapsamlı API anahtarı oluşturun

Bir organizasyon kapsamlı yazma anahtarı gerekir. Gizli değer sunucu tarafında oluşturulur ve yanıtta tam olarak bir kez döndürülür; güvenli biçimde saklayın. Yalnızca özeti tutulur.

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

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

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	yol	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 değer içerir)

{
	"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: ö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, kuruluş etkin değil ya da plan dosya türünü engelliyor

Kuruluş kapsamlı API anahtarını güncelleyin

Bir organizasyon kapsamlı yazma anahtarı gerekir. Kapsam alanları kayıtlı kapsamla birleştirilir.

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

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

Parametreler:

Ad	Tür	Konum	Zorunlu	Açıklama
tenantId	string	yol	Evet	Biçim: uuid
keyId	string	yol	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: ö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, kuruluş etkin değil ya da plan dosya türünü engelliyor
• 404 Kaynak bulunamadı

Kuruluş kapsamlı API anahtarını silin

Bir organizasyon kapsamlı yazma anahtarı gerekir. Anahtar mantıksal olarak silinir ve kimlik doğrulamada hemen kullanılamaz.

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

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

Parametreler:

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

Yanıt (200):

API anahtarı silindi

{
	"message": "string"
}

Alan	Tür	Zorunlu	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, kuruluş etkin değil ya da plan dosya türünü engelliyor
• 404 Kaynak bulunamadı