Kaynaklar · Kimlik Doğrulama
Kimlik Doğrulama ve Kapsam Dokümantasyonu
JWT/oturum kimlik doğrulaması, API anahtarı doğrulaması, kapsam başlıkları, çalışma alanı bağlamı ve doğrulama kuralları için üretime hazır rehber.
Kimlik Doğrulama Yöntemleri
- Kullanıcı bağlamındaki istekler için JWT/oturum kimlik doğrulaması.
- Servisler arası ve kontrollü entegrasyonlar için API anahtarı kimlik doğrulaması.
Gerekli Başlıklar
Authorization: Bearer [jwt_token] OR X-API-Key: [api_key]Content-Type: application/jsonX-Scope-Type: personal | workspaceX-Workspace-ID: yalnızca workspace kapsamı için gereklidir
Kapsam Modeli
- Kişisel kapsam, doğrulanmış kullanıcı bağlamında çalışır.
- Çalışma alanı kapsamı, belirli bir workspace içinde rol bazlı kontrollerle çalışır.
Doğrulama Kuralları
- Kapsam kişisel ise X-Workspace-ID sağlanmamalıdır.
- Eğer scope workspace ise X-Workspace-ID zorunludur.
- Geçersiz veya çakışan scope başlıkları 422 döndürür.
JWT Kimlik Doğrulama Örneği
bash
curl -X POST "/api/v1/chat/completions" \
-H "Authorization: Bearer [jwt_token]" \
-H "Content-Type: application/json" \
-H "X-Scope-Type: personal" \
-d '{
"message":"Hello from JWT auth",
"stream":false
}'API Anahtarı Kimlik Doğrulama Örneği
bash
curl -X POST "/api/v1/chat/completions" \
-H "X-API-Key: [api_key]" \
-H "Content-Type: application/json" \
-H "X-Scope-Type: workspace" \
-H "X-Workspace-ID: [workspace_uuid]" \
-d '{
"message":"Hello from API key auth",
"stream":false
}'Çalışma Alanı Kapsamı
json
{
"headers": {
"X-Scope-Type": "workspace",
"X-Workspace-ID": "[workspace_uuid]"
},
"note": "Workspace scope requires workspace id."
}Kişisel Kapsam
json
{
"headers": {
"X-Scope-Type": "personal"
},
"note": "Personal scope must not include workspace id."
}Hata Modelleri
401
Kimlik doğrulama eksik, süresi dolmuş veya geçersiz.
403
Scope izinli değil veya workspace içinde rol kısıtlaması var.
422
Başlık/bağlam doğrulaması başarısız oldu.
429
Mevcut kimlik doğrulama bağlamı için istek limiti aşıldı.