Dokümantasyon
ErtisAuth kullanım kılavuzu ve REST API referansı.
ErtisAuth, ASP.NET Core ve MongoDB üzerine kurulu, kendi sunucunuzda çalışan bir kimlik ve erişim yönetimi (IAM) sunucusudur. Kullanıcıları ve uygulamaları giriş yaptırır, kullanıcılar ve uygulamalar arası iletişimi ve makineler arası iletişimi güvenli hale getirir, token üretir ve aynı kullanıcıları ve yetkileri paylaşan istediğiniz sayıda uygulama için her çağıranın, her kaynak ve işlemde tanımlı yetkilerine bağlı olarak ne yapıp ne yapamayacağına karar verir.
Bu dokümantasyon ErtisAuth'un eksiksiz rehberidir: nasıl çalıştığını, nasıl çalıştırılacağını ve REST API'sinin tüm endpoint'lerini istek ve yanıt örnekleriyle anlatır. Etkileşimli OpenAPI referansı (geliştirme ortamındaki bir sunucuda /docs) aynı endpoint'leri listeler; bu dokümantasyon bunlara kavramları, birden fazla endpoint'i birleştiren akışları ve yalnızca bir şemanın gösteremeyeceği kuralları ekler.
Nereden başlamalı#
| Şunu yapmak istiyorsanız... | Okuyun |
|---|---|
| ErtisAuth'u ilk kez çalıştırmak | Başlangıç |
| Yapı taşlarını anlamak | Temel Kavramlar |
| Tüm endpoint'lerin ortak kurallarını öğrenmek | API Kuralları |
| Kullanıcıları giriş yaptırmak ve token'larla çalışmak | Kimlik Doğrulama |
| Kimin neyi yapabileceğini belirlemek | Yetkilendirme |
| Kendi .NET API'lerinizi ErtisAuth ile korumak | .NET SDK |
| ErtisAuth'u production'da çalıştırmak | Operasyon |
Rehberler#
- Başlangıç: kurulum, yapılandırma, ilk kurulum ve ilk token'ınız.
- Yapılandırma: sunucunun tüm ayarları.
- Temel Kavramlar: membership'ler, kullanıcılar, kullanıcı tipleri, roller, uygulamalar ve dahası.
- API Kuralları: route'lar, header'lar, sayfalama, sorgular ve hatalar.
- Kimlik Doğrulama: token'lar, giriş, yenileme, doğrulama ve çıkış.
- Yetkilendirme: RBAC ve UBAC yetki modeli.
- Hesap Kurtarma ve Aktivasyon: aktivasyon e-postaları, şifre sıfırlama ve tek kullanımlık şifreler.
- Cihaz Kodu Akışı: klavyesi olmayan cihazlarda giriş.
- Harici Kimlik Sağlayıcılar: Google, Apple, Facebook ve Microsoft ile giriş.
- Olaylar, Webhook'lar ve Mail Hook'lar: bir membership'te olup bitenlere tepki verin.
- .NET SDK: istemci SDK'sı ve ASP.NET Core entegrasyonu.
- Operasyon: health check'ler, metrikler, loglama, index'ler ve production kontrol listesi.
API referansı#
| Kaynak | Sayfa |
|---|---|
| İlk kurulum, health check | Başlangıç, Operasyon |
| Token'lar | Kimlik Doğrulama |
| Aktif token'lar, iptal edilmiş token'lar | Oturumlar |
| Membership'ler | Membership'ler |
| Kullanıcılar | Kullanıcılar |
| Kullanıcı tipleri | Kullanıcı Tipleri |
| Roller | Roller |
| Uygulamalar | Uygulamalar |
| Sağlayıcılar | Harici Kimlik Sağlayıcılar |
| Kod politikaları, token kodları | Cihaz Kodu Akışı |
| Olaylar | Olaylar |
| Webhook'lar | Webhook'lar |
| Mail hook'lar | Mail Hook'lar |
| Hata kodları | Hata Kodları |
Lisans#
ErtisAuth, MIT Lisansı ile açık kaynaktır.
Dokümantasyonda bir hata mı buldunuz? Issue açın