Toggle User Status
Kullanıcı Durumunu Değiştir
Offline kapsamındaki mevcut bir kullanıcının aktif/pasif durumunu tersine çevirir (toggle). Bu endpoint; sigorta şirketlerinin veya acentelerin kendi kapsamlarındaki bir kullanıcıyı pasifleştirmesine veya yeniden aktifleştirmesine olanak tanır. Endpoint kullanıcıyı silmez veya yeni kayıt oluşturmaz; yalnızca Disabled alanının değerini tersine çevirir. İstek; kimlik kapsamı çözümlemesi ve hedef kullanıcı erişim kontrolünden sonra durum değişikliğini gerçekleştirir.
Endpoint Bilgisi
Yetkilendirme Rolleri
Çağıranın aşağıdaki rollerden birine sahip olması gerekir:
Not: Endpoint
Updatepolicy’si ile korunur. Bu rollere sahip olmayan kullanıcılar403 Forbiddenalır.
Route Parametreleri
İstek Gövdesi
Bu endpoint istek gövdesi kabul etmez. Değiştirilecek kullanıcı yalnızca route parametresi üzerinden belirtilir.
Toggle Davranışı: Endpoint hedef alınan kullanıcının mevcut durumuna göre işlem yapar: aktif kullanıcı pasife, pasif kullanıcı aktife çevrilir. İstekte hedef durum bilgisi gönderilmez.
İstek Örneği
Yanıt Formatı
Başarılı Yanıt
HTTP Durumu: 204 No Content
Başarılı işlemde yanıt gövdesi boştur.
Hata Yanıtı
HTTP Durum Kodları
Hata Kodları Referansı
İşleme Akışı
Endpoint, isteği aldığında aşağıdaki adımları sırasıyla uygular:
-
Kimlik Doğrulama — Bearer token doğrulanır; token yoksa/geçersizse
401döner. -
Yetkilendirme —
Updatepolicy’si veInsuranceCompanyAPIAdmin/Supervizorrolü kontrol edilir; yetersizse403döner. -
Id Kontrolü — Route’taki
idparametresi boş veya geçersizseOfflineUsers.IdRequiredkoduyla400döner. -
Identity Scope Çözümleme — Token claim’lerinden
InsuranceCompanyIds(company) veyaAgentId(agent) okunur. Uygun rol/scope yoksa403döner. -
Hedef Kullanıcı Erişim Kontrolü — Company scope için ve agent scope için erişim kontrolü yapılır. Hedef kullanıcı kapsam dışındaysa
OfflineUsers.NotAccessibleile403döner. -
Durum Toggle İşlemi — Business katmanında kullanıcının
Disabledalanı tersine çevrilir ve Identity güncellemesi yapılır. -
Sonuç — Başarıyla güncellenirse
204 No Contentdöner. Identity güncellemesi başarısız olursaOfflineUsers.ToggleStatusFailedkoduyla500döner.
Notlar
-
Toggle Semantiği: Endpoint hedef durumu kendi belirler; mevcut durumun tersine çevirir. Bir kullanıcıyı belirli bir duruma (örn. yalnızca pasif yapmak) set etmek için tasarlanmamıştır. Çağıran taraf, mevcut durumu bildiği varsayımıyla işlemi tetiklemelidir.
-
Silme Değil, Pasifleştirme: Bu endpoint kullanıcıyı silmez. Yalnızca
Disabledsütununu günceller. Pasifleştirilen kullanıcı sisteme giriş yapamaz ancak verisi korunur. -
Identity Scope: İşlem, yalnızca çağıran tokenın kapsamındaki (şirket veya acente) kullanıcılar üzerinde yapılabilir. Kapsam dışındaki kullanıcılara yapılan istekler
OfflineUsers.NotAccessibleile reddedilir. -
İstek Gövdesi: Bu endpoint body kabul etmez. Gönderilen gövde yok sayılır; yalnızca route parametresi olan
iddikkate alınır.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
