Bu Sayfada

API Referansı: Organizasyon Yönetimi

Organizasyon Endpoint’leri

Organizasyonlar, birden fazla tenant’ı aynı çatı altında toplar.

Get Organization

Bir tenant’ın bağlı olduğu organizasyon bilgilerini alın.

Endpoint: GET /tenant/{tenantId}/organization

Parametreler:

NameTypeLocationRequiredAçıklama
tenantIdstringpathEvetTenant’ın benzersiz kimliği

Yanıt:

{
	"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
	"displayName": "Acme Corporation",
	"createdAt": "2023-06-01T00:00:00Z"
}

Get Organization İstatistikler

Tüm organizasyonun toplu istatistiklerini alın.

Endpoint: GET /tenant/{tenantId}/organization/statistics

Parametreler:

NameTypeLocationRequiredAçıklama
tenantIdstringpathEvetTenant’ın benzersiz kimliği

Yanıt:

{
	"tenantCount": 5,
	"totalProcessCount": 42,
	"totalDatasetCount": 18,
	"totalUserCount": 25,
	"totalStorageUsedBytes": 5368709120
}

List Organization Tenants

Organizasyondaki tüm tenant’ları listeleyin.

Endpoint: GET /tenant/{tenantId}/organization/tenants

Parametreler:

NameTypeLocationRequiredAçıklama
tenantIdstringpathEvetTenant’ı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"
	}
]

Create Tenant

Organizasyon içinde yeni bir tenant oluşturun.

Endpoint: POST /tenant/{tenantId}/organization/tenants

Parametreler:

NameTypeLocationRequiredAçıklama
tenantIdstringpathEvetOrganizasyonda mevcut bir tenant’ın benzersiz kimliği

İstek Gövdesi:

{
	"shortName": "sales-team",
	"displayName": "Sales Team",
	"description": "Tenant for the sales department"
}
FieldTypeRequiredAçıklama
shortNamestringEvetURL’e uygun kimlik (küçük harf, tire kullanılabilir)
displayNamestringHayırTenant için okunabilir ad
descriptionstringHayırTenant açıklaması

Yanıt: Oluşturulan tenant nesnesini döndürür.


Delete Tenant

Bir tenant’ı organizasyondan silin.

Endpoint: DELETE /tenant/{tenantId}/organization/tenants/{targetTenantId}

Parametreler:

NameTypeLocationRequiredAçıklama
tenantIdstringpathEvetOrganizasyonda mevcut bir tenant’ın kimliği
targetTenantIdstringpathEvetSilinecek 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.


Organizasyon Kullanıcı Endpoint’leri

List Organization Users

Organizasyondaki tüm kullanıcıları listeleyin.

Endpoint: GET /tenant/{tenantId}/organization/users

Parametreler:

NameTypeLocationRequiredAçıklama
tenantIdstringpathEvetTenant’ı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
	}
]

Update Organization User

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
}
FieldTypeRequiredAçıklama
userIdstringEvetKullanıcının benzersiz kimliği
organizationIdstringEvetOrganizasyonun benzersiz kimliği
isActiveInOrganizationbooleanHayırKullanıcı organizasyonda aktif mi
isAdminInOrganizationbooleanHayırKullanıcı organizasyonda admin yetkisine sahip mi

Yanıt:

{
	"message": "User organization settings updated."
}

Remove Organization User

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"
}
FieldTypeRequiredAçıklama
userIdstringEvetKaldırılacak kullanıcının benzersiz kimliği
organizationIdstringEvetOrganizasyonun 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.