Skip to navigation
Insurgateway APIOffline

GetAllUsers

Kullanıcıları Listele

Token’daki yetki kapsamına göre sigorta şirketi ve/veya acente kapsamındaki kullanıcıları sayfalı (paginated) olarak listeler. Kullanıcı adı, e-posta ve aktiflik durumuna göre filtreleme ile dinamik sıralama desteği sunar.

Endpoint Bilgisi

ÖzellikDeğer
HTTP MetoduGET
URL/api/offline/users
Content-Type—
YetkilendirmeAuthorization: Bearer {token}

Yetkilendirme Rolleri

Çağıranın aşağıdaki rollerden birine sahip olması gerekir:

RolErişim Kapsamı
InsuranceCompanyAPIAdminToken’daki yetki kapsamı dahilindeki kullanıcıları listeleyebilir
SupervizorToken’daki yetki kapsamı dahilindeki kullanıcıları listeleyebilir

Not: Ek olarak Read policy yetkisi gereklidir.

Query Parametreleri

ParametreTipZorunluVarsayılanAçıklamaDoğrulama Kuralları
PageintegerHayır1Sayfa numarası1’den büyük veya eşit olmalı: "Page must be greater than or equal to 1."
PageSizeintegerHayır50Sayfa başı kayıt sayısı1–200 arasında olmalı: "PageSize must be between 1 and 200."
SortOrderstringHayırdescSıralama yönü: asc veya descGeçerli değer: "SortOrder must be 'asc' or 'desc'."
SortBystringHayırfullNameSıralama alanıGeçerli değerler: fullName, userName, email, lastLogin: "SortBy must be one of: fullName, userName, email, lastLogin."
UserNamestringHayır—Kullanıcı adına göre filtre (Contains)Min 3, Maks 256 karakter
EmailstringHayır—E-postaya göre filtre (Contains)Min 3, Maks 256 karakter
IsActivebooleanHayırnullAktiflik durumu filtresiGeçerli değerler: true, false

Aktiflik Filtresi Davranışı

API’deki IsActive alanı, veritabanı tarafındaki Disabled alanına dönüştürülür:

IsActive DeğeriUygulanan Koşul
trueAktif kullanıcılar (Disabled == false)
falsePasif kullanıcılar (Disabled == true)
null / boşDurum filtresi uygulanmaz

Sıralama Davranışı

  • SortOrder: yalnızca asc veya desc kabul eder; geçersiz değer validation hatası üretir.

  • SortBy: Boş gelirse varsayılan olarak fullName kullanılır.

  • Eşitlik durumunda Id alanı ile ikincil sıralama (tie-break) uygulanır.

Yetki Kapsamı

Yetki kapsamı, çağıranın sahip olduğu role göre belirlenir. Kullanıcı company veya agent rollerinden en az birine sahip değilse istek reddedilir.

  • Kullanıcı company ya da agent rolünde değilse 403 Forbidden döner.

    • Hata kodu: OfflineUsers.AgentOrCompanyRoleRequired

  • Kullanıcı company rolüne sahipse, token’daki InsuranceCompanyIds claim’i okunur.

    • Liste boşsa 403 Forbidden döner.
      • Hata kodu: OfflineUsers.InsuranceCompanyNotFound
    • Liste doluysa ilgili şirketlere bağlı kullanıcılar filtrelenir.

  • Kullanıcı agent rolüne sahipse, token’daki AgentIds claim’i okunur.

    • Liste boşsa 403 Forbidden döner.
      • Hata kodu: OfflineUsers.AgentNotFound
    • Liste doluysa ilgili acentelere bağlı kullanıcılar filtrelenir.

  • Kullanıcı her iki role de sahipse iki filtre birlikte uygulanır.

Hata Yanıtları

HTTP KoduHata KoduMesajAçıklama
403OfflineUsers.AgentOrCompanyRoleRequired—Kullanıcı company ya da agent rolünde değil
403OfflineUsers.InsuranceCompanyNotFound—Company rolündeki kullanıcının token’ında geçerli şirket ataması bulunamadı
403OfflineUsers.AgentNotFound—Agent rolündeki kullanıcının token’ında geçerli acente ataması bulunamadı

Yanıt Formatı

PagedData Alanları

AlanTipAçıklama
TotalCountintegerToplam kayıt sayısı
PageintegerMevcut sayfa
SizeintegerSayfa boyutu
TotalPageintegerToplam sayfa sayısı
HasNextPagebooleanSonraki sayfa var mı
HasPreviousPagebooleanÖnceki sayfa var mı
ItemsarrayKullanıcı listesi

UserDTO Alanları

AlanTipAçıklama
IdstringKullanıcı kimliği
FullNamestringAd soyad
UserNamestringKullanıcı adı
EmailstringE-posta adresi
EmailConfirmedbooleanE-posta doğrulanmış mı
DisabledbooleanKullanıcı pasif mi
LastLogindatetimeSon giriş tarihi
UserRolesarrayRol adları
AssignedRolesstringRol adlarının virgülle birleşmiş hali

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response headers

Content-TypestringOptional

Response

OK

Errors

400
Bad Request Error
403
Forbidden Error