Kullanıcı API'si
mindzieStudio platformu genelinde kullanıcıları yönetin. Esnek API kapsamlarıyla kullanıcı oluşturun, güncelleyin ve kiracılara atayın.
Özellikler
Genel İşlemler
Sistem genelinde kullanıcı yönetimi için Global API Anahtarı kullanılır. Tüm kullanıcıları listeleyin, kullanıcı oluşturun, özellikleri güncelleyin ve tüm platform genelinde kiracı atamalarını yönetin.
Kiracı İşlemleri
Kiracı kapsamlı kullanıcı yönetimi, Global veya Kiracı API Anahtarları ile çalışır. Belirli bir kiracı bağlamında kullanıcıları yönetin.
Roller ve İzinler
Kullanıcı rolleri erişim seviyelerini ve yetenekleri tanımlar. Rol hiyerarşisini, hizmet hesaplarını ve erişim yönetimi için en iyi uygulamaları anlayın.
API Kapsamları
Kullanıcı API'sinin iki kapsamı vardır:
| Kapsam | Temel Yol | API Anahtarı Gerekliliği |
|---|---|---|
| Global | /api/user |
Global API Anahtarı |
| Kiracı kapsamlı | /api/tenant/{tenantId}/user |
Global veya Kiracı API Anahtarı |
Mevcut Endpointler
Genel Kullanıcı Endpointleri
| Metod | Endpoint | Açıklama |
|---|---|---|
| GET | /api/user |
Tüm kullanıcıları listele |
| POST | /api/user |
Kullanıcı oluştur |
| GET | /api/user/{userId} |
ID ile kullanıcıyı getir |
| PUT | /api/user/{userId} |
Kullanıcıyı güncelle |
| GET | /api/user/by-email/{email} |
E-posta ile kullanıcıyı getir |
| GET | /api/user/{userId}/tenants |
Kullanıcının kiracılarını getir |
Kiracı Kapsamlı Kullanıcı Endpointleri
| Metod | Endpoint | Açıklama |
|---|---|---|
| GET | /api/tenant/{tenantId}/user |
Kiracın kullanıcılarını listele |
| POST | /api/tenant/{tenantId}/user |
Kiracıya kullanıcı oluştur |
| GET | /api/tenant/{tenantId}/user/{userId} |
Kiracıdaki kullanıcıyı getir |
| PUT | /api/tenant/{tenantId}/user/{userId} |
Kiracıdaki kullanıcıyı güncelle |
| GET | /api/tenant/{tenantId}/user/by-email/{email} |
Kiracı içinde e-posta ile getir |
| POST | /api/tenant/{tenantId}/user/{userId} |
Kullanıcıyı kiracıya ata |
| DELETE | /api/tenant/{tenantId}/user/{userId} |
Kiracıdan kaldır |
Kullanıcı Rolleri
| Rol (görünüm) | API rol adı | Seviye | Açıklama |
|---|---|---|---|
| Sunucu Yöneticisi | TenantAdmin |
Sistem | En yüksek erişim. Tüm kiracılar ve sunucu genelinde tam erişim. |
| Yönetici | Administrator |
Kiracı | Kiracı içinde tam idari yetki. |
| BT Yöneticisi | ITAdmin |
Kiracı | Entegrasyonlar, bağlantılar ve global API anahtarları. |
| Analist | Analyst |
Proje | Analizler, panolar ve incelemeler oluşturup yönetir. |
| Geliştirici | Developer |
Proje | Entegrasyonlar oluşturur, eylem ve uygulamaları yönetir. |
| Kullanıcı | User |
Salt okunur | Panoları ve analizleri görüntüler; içerik değiştiremez. |
Tam rol kılavuzu için Roller ve İzinler sayfasına bakın.
Kimlik Doğrulama
| Endpoint Kapsamı | API Anahtarı Türü | Erişim |
|---|---|---|
Global (/api/user) |
Global API Anahtarı | Tüm kiracılar |
| Kiracı kapsamlı | Global API Anahtarı | Tüm kiracılar |
| Kiracı kapsamlı | Kiracı API Anahtarı | Yalnızca kendi kiracısı |
API anahtarı türleri ve kullanımı için Kimlik Doğrulama sayfasına bakın.
Hızlı Başlangıç
# Tüm kullanıcıları listele (Global API anahtarı gereklidir)
curl -X GET "https://your-mindzie-instance.com/api/user" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Bir kiracıdaki kullanıcıları listele (Kiracı API anahtarı kullanılabilir)
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}/user" \
-H "Authorization: Bearer YOUR_TENANT_API_KEY"
Önemli Notlar
- Global ve Kiracı Anahtarları: Çoğu işlem için kiracı kapsamlı anahtarları kullanın; global anahtarları sistem yönetimi için ayırın
- Kullanıcı Devre Dışı Bırakma: Kullanıcıları silmek yerine
disabled: truekullanarak denetim kayıtlarını koruyun - Hizmet Hesapları: Yalnızca Sunucu Yöneticisi (
TenantAdmin) ve Yönetici rolleri hizmet hesabı olabilir - Kapasite Sınırları: Kiracıların yapılandırılabilir kullanıcı ve analist limitleri vardır