Toggle User Status
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Bearer authentication of the form Bearer <token>, where token is your auth token.
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.
Ç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.
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.
HTTP Durumu: 204 No Content
Başarılı işlemde yanıt gövdesi boştur.
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 401 döner.
Yetkilendirme — Update policy’si ve InsuranceCompanyAPIAdmin / Supervizor rolü kontrol edilir; yetersizse 403 döner.
Id Kontrolü — Route’taki id parametresi boş veya geçersizse OfflineUsers.IdRequired koduyla 400 döner.
Identity Scope Çözümleme — Token claim’lerinden InsuranceCompanyIds (company) veya AgentId (agent) okunur. Uygun rol/scope yoksa 403 dö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.NotAccessible ile 403 döner.
Durum Toggle İşlemi — Business katmanında kullanıcının Disabled alanı tersine çevrilir ve Identity güncellemesi yapılır.
Sonuç — Başarıyla güncellenirse 204 No Content döner. Identity güncellemesi başarısız olursa OfflineUsers.ToggleStatusFailed koduyla 500 döner.
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 Disabled sü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.NotAccessible ile reddedilir.
İstek Gövdesi: Bu endpoint body kabul etmez. Gönderilen gövde yok sayılır; yalnızca route parametresi olan id dikkate alınır.