Ç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) vekeys:update. Bu ikisinden birini vermeye çalışan birPOST /keysveyaPATCH /keys/:idisteğ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ğıdakikeys:updatesatı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:

İş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 daalerts:readya daalerts:writesahibi tarafından erişilebilir, bu nedenle uyarı editörleriusers:readverilmeden seçiciyi doldurabiliyor.
Pano görüntüleyicisi hem dedashboards:read(kaydedilmiş görünümleri yüklemek için) hem deevaluations:readgerekli (sağlık metrikleri değerlendirme verilerinden hesaplanır). Bir kullanıcıya pano oluşturmaya veya düzenlemesine izin vermek içindashboards:writeverin ve bunları kaldırmak içindashboards:deleteverin.
/healthve/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-grantersgeç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)standardsetine varsayılan olarak ayarlanır.agenteye-orgctlüzerinde--setbayrağı (operatör üyesi yönetimi) bir üyeyi adlandırılmış bir setten başlatır; bunu daha sonra--add/--removeile 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. SunucudaADMIN_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ı (veyakeys:create izni olan herhangi bir anahtarı) kullanın.
Toplayıcı anahtarı (yalnızca yutma)
Kontrol paneli anahtarı (salt okunur)
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ı 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.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çinkeys: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).

Önerilen Anahtar Düzeni
Not: Asistanın anahtarı sunucu tarafındanAGENT_API_KEYortam değişkeninden otomatik olarak başlatılır (ajanınAGENTEYE_API_KEYolarak 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.adminanahtarı gibi, korunan: anahtarlar API’si aracılığıyla devre dışı bırakılamaz veya yeniden oluşturulamaz, yalnızcaAGENT_API_KEYdeğiştirerek ve yeniden başlatarak döndürülür. Kontrol paneli kullanıcıları ek olarak asistanı görmek ve kullanmak içinagent:useizni gerektirir. Öz enstrümantasyonu etkinleştirirseniz, asistana ayrı birevents: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:readtutan her kullanıcı ve izin setiaudits:readkazandı vealerts:writesahibiaudits:writekazandı. Mevcut API anahtarları genişletilmedi. Denetim yüzeyine ihtiyacı olan bir anahtaraaudits:*açıkça verin.
Eskialerts:ackjetonunun depolanan hibeleriincidents:ackolarak 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 yerineincidents:acksunar.
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.

