Kiracı API
mindzieStudio için sistem düzeyinde kiracı yönetim işlemleri. Platform genelinde kiracılar oluşturun, listeleyin, güncelleyin ve silin.
ÖNEMLİ: Tüm Kiracı API uç noktaları Global API Anahtarı gerektirir. Normal kiracıya özel API anahtarları bu uç noktalara erişemez.
Özellikler
Yönetim
Tüm kiracıları listeleyin, kiracı detaylarını alın, yeni kiracılar oluşturun ve kiracı ayarlarını güncelleyin. Kullanıcı limitlerini, vaka limitlerini ve kiracı özelliklerini yapılandırın.
Silme
Kiracıları kalıcı olarak üçlü doğrulama ile güvenli şekilde silin. Veri dışa aktarma ve güvenli silme iş akışları için en iyi uygulamalar dahil edilmiştir.
Kullanılabilir Uç Noktalar
| Yöntem | Uç Nokta | Açıklama |
|---|---|---|
| GET | /api/tenant |
Tüm kiracıları listele |
| GET | /api/tenant/{tenantId} |
ID ile kiracı al |
| POST | /api/tenant |
Kiracı oluştur |
| PUT | /api/tenant |
Kiracıyı güncelle |
| DELETE | /api/tenant |
Kiracıyı sil |
Kiracı Nesnesi Alanları
| Alan | Tür | Açıklama |
|---|---|---|
tenantId |
GUID | Kiracı için benzersiz tanımlayıcı |
name |
string | Benzersiz sistem adı (URL'lerde kullanılır) |
displayName |
string | İnsan tarafından okunabilir görüntü adı |
description |
string | Kiracının açıklaması |
caseCount |
integer | Toplam vaka sayısı |
maxUserCount |
integer | İzin verilen maksimum kullanıcı sayısı |
maxAnalystCount |
integer | İzin verilen maksimum analist sayısı |
userCount |
integer | Mevcut kullanıcı sayısı |
analystCount |
integer | Mevcut analist sayısı |
isDisabled |
boolean | Kiracının devre dışı olup olmadığı |
isAcademic |
boolean | Bu kiracının akademik olup olmadığı |
preRelease |
boolean | Kiracının ön sürüm özelliklerine sahip olup olmadığı |
dateCreated |
datetime | Kiracı oluşturulma tarihi |
Kimlik Doğrulama
| Uç Nokta | API Anahtarı Türü | Erişim |
|---|---|---|
Tüm /api/tenant uç noktaları |
Global API Anahtarı | Gerekli |
| Kiracı API Anahtarı | 401 Yetkisiz |
Global API anahtarları /admin/global-api-keys üzerinden yönetici arayüzü ile oluşturulabilir.
API anahtarı türleri ve kullanımı için Kimlik Doğrulama sayfasına bakın.
Hızlı Başlangıç
# Tüm kiracıları listele (Global API anahtarı gereklidir)
curl -X GET "https://your-mindzie-instance.com/api/tenant" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Belirli bir kiracıyı al
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
Önemli Notlar
- Sadece Global API Anahtarları: Tüm kiracı uç noktaları Global API anahtarları gerektirir
- Lisans Limitleri: Kiracı sayısını lisans limitlerine karşı izleyin
- Yıkıcı İşlemler: Kiracı silme işlemi kalıcıdır ve geri alınamaz
- Üçlü Doğrulama: Silme işlemi için kimlik, isim ve görüntü adı tam eşleşmelidir
- Devre Dışı Bırakma vs Silme: Veriyi koruyup erişimi engellemek için kiracıyı devre dışı bırakmayı düşünün