Skip to main content
API anahtarları Failproof AI Gözlemlenebilirlik sunucunuza erişebilecek olanları ve neleri kontrol eder, bu sayede bir toplayıcı hiçbir zaman okuma veya yönetici yetkisi kazanmadan olayları gönderebilir. Her anahtar bir veya daha fazla izne sahiptir ve her izin belirli sunucu rotalarını denetler; yalnızca bir işin ihtiyacı olan izinleri verirsiniz. Çoğu dağıtımda sadece üç tür anahtar oluşturulur.

Çoğu dağıtımın ihtiyacı olan 3 anahtar

Buradan başlayın. Daha dar, özel kapsamlı bir anahtar gerekirse, aşağıdaki tam izin kataloğuna başvurun. Ayrıca bkz. Önerilen anahtar düzeni ve Anahtar oluşturma.

İzinler

Sunucu sabit bir izin kataloğu uygular; her biri belirli HTTP rotalarını denetler. Bir yönetici anahtarı hepsini tutar; kapsamlı bir anahtar oluşturma sırasında verdiğiniz alt kümesini tutar. Bilinmeyen izin dizeleri anahtar oluşturulduğunda reddedilir.
Not: İki geçerli izin insan/kontrol paneli özeldir ve API anahtarına verilemez: orgs:admin (örnek yönetimi, yalnızca operatör için) ve keys:update. Bu ikisinden birini vermeye çalışan bir POST /keys veya PATCH /keys/:id isteği HTTP 422 ile reddedilir. Bir taşıyıcı anahtarın anahtarlar oluşturabilmesinin ama hiçbir zaman bunları düzenleyememesinin nedenini görmek için aşağıdaki keys:update satırına bakın.

Olayları yutma ve sorgulama

Oturumlar ve değerlendirmeler

Kontrol Panoları

Kaydedilmiş sorgular (SQL oluşturucu)

Yapay zeka asistanı

API Anahtarları

Kontrol Paneli Kullanıcıları

Bu izinler kontrol panelinin Kullanıcılar sayfasını destekler; burada her üyenin verilen kapsamları yonga olarak gösterilir: Kullanıcılar sayfası: kontrol paneli kullanıcısı başına kart, e-posta, verilen izinler ve düzenle/devre dışı bırak kontrolleriyle

İşletimsel ayarlar

Ayarlar sayfası: sunucuyu yeniden başlatmadan düzenlenebilen izin verilen oturum açmalar ve oturum/OTP yaşam süreleri gibi kontrol paneli tarafından yönetilen işletimsel ayarlar

Uyarılar ve olaylar

Denetimler

Not: Bir anahtara denetim yüzeyini vermek için audits:* açıkça veriniz. Denetimler yayınlandığında mevcut izin alanlarının nasıl taşındığını görmek için Yükseltme ve geriye dönük uyumluluk notları bölümüne bakın.
Alıcı seçici uç noktası GET /alerts/recipients (uyarı editörünün bildirilebileceği üye e-postalarını listeler) ya da alerts:read ya da alerts:write sahibi tarafından erişilebilir, bu nedenle uyarı editörleri users:read verilmeden seçiciyi doldurabiliyor.
Pano görüntüleyicisi hem de dashboards:read (kaydedilmiş görünümleri yüklemek için) hem de evaluations:read gerekli (sağlık metrikleri değerlendirme verilerinden hesaplanır). Bir kullanıcıya pano oluşturmaya veya düzenlemesine izin vermek için dashboards:write verin ve bunları kaldırmak için dashboards:delete verin.
/health ve /auth/* (OTP isteği, OTP doğrula, oturum kontrol, çıkış) tasarım gereği kimlik doğrulamadan uzak; bunlar oturum açma akışı ve canlılık koşuşturmacasıdır. GET /access-granters geçerli bir anahtar gerektirir ama belirli izin yok, bu nedenle oturum açmış herhangi bir kullanıcı erişim değişiklikleri hakkında hangi yöneticilere başvurması gerektiğini görebilir.

İzin Setleri

İzin setleri her seferinde bireysel jetonları el ile seçmek yerine adlandırılmış bir rol uygulamanıza izin verir. Her yeni kontrol paneli kullanıcısı veya API anahtarı için bir düzine izni tek tek seçmek yerine, bir set seçersiniz ve herkese atanan set tutarlı, gözden geçirilebilir bir hibe taşır. Özel bir set düzenlemek zaten buna atanan her kullanıcıya yeni hibe yeniden uygular, bu nedenle bir rol değişikliği her üyeyi taramak yerine bir düzenleme olur. Her kuruluş üç yerleşik sette başlatılır: Üç yerleşik set değişmez; adları her zaman aynı şeyi anlamlandırır, bu nedenle read-only, standard ve admin ilke ve getirişte referans vermek güvenlidir. Bir operatör kuruluşunuza özel rolleri modellemek için ek özel setler oluşturabilir (örneğin, bir “pano yazarı” rolü veya “toplayıcı-yalnızca” rolü). Setler kontrol panelinde yüzeylendirilir ve GET /permission-sets (liste, users:read tarafından gated) ve POST /permission-sets / PUT /permission-sets/:name / DELETE /permission-sets/:name (özel bir seti oluştur, düzenle, sil, settings:write tarafından gated) üzerinde API’de yönetilir. Yerleşik bir seti silmek veya düzenlemek reddedilir. Set üyeliği iki diğer özelliği destekler:
  • DEFAULT_USER_PERMISSIONS (yönetici + yeni kullanıcı açtığında önceden seçilen hibe) standard setine varsayılan olarak ayarlanır.
  • agenteye-orgctl üzerinde --set bayrağı (operatör üyesi yönetimi) bir üyeyi adlandırılmış bir setten başlatır; bunu daha sonra --add / --remove ile ince ayar yaparsınız.
Not: Bir set anahtar atanabilir olmayan bir izni içerdiğinde (örneğin keys:update taşıyan özel bir set), bu setten bir anahtar tohumlamak atanabilir olmayan jetonları bırakır; sunucu aksi takdirde anahtarı HTTP 422 ile reddederdi. Kontrol paneli kullanıcıları bu kısıtlamaya tabi değildir.

Önyükleme Yönetici Anahtarı

Yönetici anahtarı, bir operatörün hiçbir şeyden erişimi getirmesine izin veren tek kök kimlik bilgileridir: bununla, diğer her kapsamlı anahtar oluşturabilir, ilk kontrol paneli kullanıcılarını davet edebilir ve başka hiçbir anahtar bulunmadığında örneği yapılandırabilirsiniz. Anahtarlar API’si aracılığıyla oluşturulmadığınız tek anahtarıdır; ilk önyüklemede sunucuya ulaşılabilir olması için ortamdan sağlanır. Sunucuda ADMIN_KEY ortam değişkenini ayarlayın. Her başlatmada sunucu bu değeri tüm izinlere sahip bir yönetici anahtarı olarak upserts. Döndürmek için: ADMIN_KEY olarak yeni bir sıra değiştirin ve sunucuyu yeniden başlatın.

Organizasyon Kapsamı

Kuruluşlar kendileri operatör tarafından banda dışı oluşturulur ve yönetilir, bu anahtarlar API’si aracılığıyla değil. Org ve üye yaşam döngüsü (kuruluş oluştur / yeniden adlandır / sil / temizle; üye ekle / güncelle / kaldır) agenteye-orgctl CLI ile yapılır; bunun için HTTP API veya kontrol paneli düğmesi yoktur. Değişmeyen şey budur: org başına API anahtarları hala kontrol panelinde (veya bu anahtarlar API’si aracılığıyla) org üyeleri tarafından oluşturulur. Çok org dağıtımında, org üyesinin oluşturduğu her anahtar (bu anahtarlar API’si veya kontrol paneli Anahtarlar sayfası aracılığıyla) tek bir kuruluşa aittir ve yalnızca o org’un verilerine okuyabilir veya yazabilir; org oluşturma sırasında anahtara damgalanır ve her istekte uygulanır. İki önyükleme anahtarı tek istisnadır: admin anahtarı (ADMIN_KEY başlatılır) ve dashboard-assistant anahtarı (AGENT_API_KEY başlatılır) örnek kapsamlıdır (org taşımaz). Kontrol paneli admin anahtarıyla kimlik doğrulaması yapar, bu nedenle oturum açmış üyeler adına kuruluş başına istekleri vekil edebilir. Tek kiracılı dağıtımlar bunun hakkında düşünmeye gerek duymaz; tüm anahtarlar yerleşik default org’a aittir.

Anahtar Oluşturma

Ek kapsamlı anahtarlar oluşturmak için yönetici anahtarını (veya keys:create izni olan herhangi bir anahtarı) kullanın.

Toplayıcı anahtarı (yalnızca yutma)

Kontrol paneli anahtarı (salt okunur)

HTTP API’nin üzerinden bir anahtar oluşturduğunuzda, key değerini kendiniz sağlarsınız; güçlü bir sıra seçin ve bunu güvenle saklayın. (Kontrol paneli başka şekilde çalışır: sizin için güçlü bir sıra oluşturur ve oluşturmada bir kez gösterir; bkz. Kontrol Panelinde Anahtar Yönetimi.) Yanıt anahtarın oluşturulduğunu onaylar:

Anahtarları Listeleme

Anahtar sırları liste yanıtlarında döndürülmez, yalnızca kimlikler, adlar ve izinler.

Anahtarı Devre Dışı Bırakma

Devre dışı bırakmak anahtar kaydını silmeden erişimi hemen iptal eder.

Anahtarı Yeniden Oluşturma

Mevcut bir anahtar için yeni bir sıra oluşturur. Eski sıra hemen geçersiz kılınır.
Yanıt yeni düz metinlik sırrı içerir, yalnızca bir kez gösterilir.

Kontrol Panelinde Anahtar Yönetimi

Kontrol panelindeki Anahtarlar sayfası yukarıdaki tüm işlemler için bir kullanıcı arayüzü sağlar. Listeyi görüntülemek için keys:read izni olan bir anahtara ihtiyacınız vardır ve oluşturma / düzenle / devre dışı bırak / yeniden oluşturma eylemleri sırasıyla keys:create / keys:update / keys:disable / keys:regenerate gerekir. Bir anahtarın izinlerini düzenlemek (keys:update) bir tane oluşturmaktan (keys:create) ayrıdır, bu nedenle bir operatöre anahtarları bastırma yeteneğini mevcut olanları yeniden kapsamlandırma yeteneği olmadan veya tam tersi verebilirsiniz. Yönetici anahtarı bunların hepsini kapsar. Kontrol panelinden bir anahtar oluşturduğunuzda sırrı sağlamıyorsunuz; kontrol paneli sizin için güçlü bir sıra oluşturur ve oluşturmada bir kez görüntüler. Hemen kopyalayın ve güvenle saklayın; yeniden oluşturma gibi asla tekrar gösterilmez. Yine de anahtarın izinlerini doğrudan seçebilir veya bir izin setinden tohumlayabilirsiniz (aşağıya bakın). API Anahtarları sayfası: anahtar başına kart, adını, verilen izinleri ve oluşturma zamanını gösterir, yeniden oluştur ve devre dışı bırak eylemleriyle; admin gibi korunan anahtarlar işaretlenir

Önerilen Anahtar Düzeni

Not: Asistanın anahtarı sunucu tarafından AGENT_API_KEY ortam değişkeninden otomatik olarak başlatılır (ajanın AGENTEYE_API_KEY olarak sunduğu aynı sıra); el ile anahtar damgalanma adımı yoktur ve hiçbir yönetici anahtarı söz konusu değildir. İzinleri kaynak kodda sabitlenmiş, böylece kapsam yanlış yapılandırma tarafından genişletilemez: olaylar / değerlendirmeler / panoları genelinde oku, artı panoları-yaz ve sorguları-oku / yaz / çalıştır “Yapay zekaya sorgu yazması isteme” yazarlık akışı için. Tüm SQL hala kullanıcı tarafından yazılan bir sorgu olarak aynı salt okunur rol ve korunan SQL yolu üzerinden gider, bu nedenle bu yazarlık yüzeyini genişletir, veri yüzeyini değil; yıkıcı işlemler (queries:delete, dashboards:delete) kasıtlı olarak asistan anahtarının dışında kalır. admin anahtarı gibi, korunan: anahtarlar API’si aracılığıyla devre dışı bırakılamaz veya yeniden oluşturulamaz, yalnızca AGENT_API_KEY değiştirerek ve yeniden başlatarak döndürülür. Kontrol paneli kullanıcıları ek olarak asistanı görmek ve kullanmak için agent:use izni gerektirir. Öz enstrümantasyonu etkinleştirirseniz, asistana ayrı bir events:add-yalnızca anahtarı verin.

Yükseltme ve geriye dönük uyumluluk notları

Yalnızca mevcut bir örneği yükseltiyorsanız bunlara ihtiyacınız vardır; yeni dağıtımlar bunları atlayabilir.
Denetimler yayınlandığında, mevcut izin alanları uyarılar olarak aynı rol şekilleriyle genişletildi: alerts:read tutan her kullanıcı ve izin seti audits:read kazandı ve alerts:write sahibi audits:write kazandı. Mevcut API anahtarları genişletilmedi. Denetim yüzeyine ihtiyacı olan bir anahtara audits:* açıkça verin.
Eski alerts:ack jetonunun depolanan hibeleri incidents:ack olarak ayrıştırılır, bu nedenle araçlar erişimi anahtarlamadan saklar. Jetons daha fazla kontrol paneli kullanıcı editöründen atanabilir değildir; matris bunun yerine incidents:ack sunar.

Sonraki Adımlar

  • Python SDK: ajan kodunuz olayları gönderirken nasıl kimlik doğrulaması yapar.
  • Güvenlik: oturum açma, erişim denetimi ve kuruluş başına veri yalıtması nasıl çalışır.