API Referansı: Tenant Yönetimi
Tenant yönetimi ve kullanıcı yetki kontrolü için API referansı.
Organizasyonlar, birden fazla tenant’ı aynı çatı altında toplar.
Bir tenant’ın bağlı olduğu organizasyon bilgilerini alın.
Endpoint: GET /tenant/{tenantId}/organization
Parametreler:
| Name | Type | Location | Required | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Tenant’ın benzersiz kimliği |
Yanıt:
{
"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"displayName": "Acme Corporation",
"createdAt": "2023-06-01T00:00:00Z"
} Tüm organizasyonun toplu istatistiklerini alın.
Endpoint: GET /tenant/{tenantId}/organization/statistics
Parametreler:
| Name | Type | Location | Required | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Tenant’ın benzersiz kimliği |
Yanıt:
{
"tenantCount": 5,
"totalProcessCount": 42,
"totalDatasetCount": 18,
"totalUserCount": 25,
"totalStorageUsedBytes": 5368709120
} Organizasyondaki tüm tenant’ları listeleyin.
Endpoint: GET /tenant/{tenantId}/organization/tenants
Parametreler:
| Name | Type | Location | Required | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Tenant’ın benzersiz kimliği |
Yanıt:
[
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"displayName": "Sales Department",
"createdAt": "2024-01-01T00:00:00Z"
},
{
"id": "d4e5f6a7-b8c9-0123-def4-567890123456",
"displayName": "Operations",
"createdAt": "2024-02-15T00:00:00Z"
}
] Organizasyon içinde yeni bir tenant oluşturun.
Endpoint: POST /tenant/{tenantId}/organization/tenants
Parametreler:
| Name | Type | Location | Required | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Organizasyonda mevcut bir tenant’ın benzersiz kimliği |
İstek Gövdesi:
{
"shortName": "sales-team",
"displayName": "Sales Team",
"description": "Tenant for the sales department"
} | Field | Type | Required | Açıklama |
|---|---|---|---|
| shortName | string | Evet | URL’e uygun kimlik (küçük harf, tire kullanılabilir) |
| displayName | string | Hayır | Tenant için okunabilir ad |
| description | string | Hayır | Tenant açıklaması |
Yanıt: Oluşturulan tenant nesnesini döndürür.
Bir tenant’ı organizasyondan silin.
Endpoint: DELETE /tenant/{tenantId}/organization/tenants/{targetTenantId}
Parametreler:
| Name | Type | Location | Required | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Organizasyonda mevcut bir tenant’ın kimliği |
| targetTenantId | string | path | Evet | Silinecek tenant’ın benzersiz kimliği |
Yanıt:
{
"success": true
} warning
Bir tenant’ı silmek, ona ait tüm süreç, veri kümesi ve kullanıcı atamalarını kalıcı olarak kaldırır. Bu işlem geri alınamaz. Kimlik doğrulaması yaptığınız tenant’ı silemezsiniz.
Organizasyondaki tüm kullanıcıları listeleyin.
Endpoint: GET /tenant/{tenantId}/organization/users
Parametreler:
| Name | Type | Location | Required | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | Tenant’ın benzersiz kimliği |
Yanıt:
[
{
"id": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"email": "admin@example.com",
"firstName": "Jane",
"lastName": "Smith",
"createdAt": "2023-06-01T00:00:00Z",
"lastLoginAt": "2024-03-01T10:00:00Z",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": true
}
] Bir kullanıcının organizasyon içindeki izinlerini güncelleyin.
Endpoint: PUT /tenant/{tenantId}/organization/users
İstek Gövdesi:
{
"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": true
} | Field | Type | Required | Açıklama |
|---|---|---|---|
| userId | string | Evet | Kullanıcının benzersiz kimliği |
| organizationId | string | Evet | Organizasyonun benzersiz kimliği |
| isActiveInOrganization | boolean | Hayır | Kullanıcı organizasyonda aktif mi |
| isAdminInOrganization | boolean | Hayır | Kullanıcı organizasyonda admin yetkisine sahip mi |
Yanıt:
{
"message": "User organization settings updated."
} Bir kullanıcıyı organizasyondan tamamen kaldırın.
Endpoint: DELETE /tenant/{tenantId}/organization/users
İstek Gövdesi:
{
"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234"
} | Field | Type | Required | Açıklama |
|---|---|---|---|
| userId | string | Evet | Kaldırılacak kullanıcının benzersiz kimliği |
| organizationId | string | Evet | Organizasyonun benzersiz kimliği |
Yanıt:
{
"message": "User removed from organization."
} warning
Bir kullanıcıyı organizasyondan kaldırmak, kişinin organizasyondaki tüm tenant’lara erişimini kaldırır.
Site deneyiminizi iyileştirmek, içerikleri kişiselleştirmek ve site trafiğini analiz etmek için çerezler kullanıyoruz. "Tümünü Kabul Et"e tıklayarak onay verirsiniz.