API Giriş

Genel

Neredeyse tüm uç noktaların kimlik doğrulaması gerekecektir. Desteklenen kimlik doğrulama yöntemleri aşağıda detaylandırılmıştır.

Her kullanıcının, rolleri tarafından tanımlanan izinleri vardır. Kullanıcının izinleri, api çağrıları yapılırken kontrol edilir.

Bazı özellikler (ve uç noktalar), daha yüksek bir lisansla yalnızca etkinleştirilir ve aşağıda ayrıntıları belirtilen TheHive yetenekleri olarak bir gereksinimler listesi tanımlar. Lisansınızın hangi yetenekleri içerdiğini görmek için /api/v1/status uç noktasına bakın. Kuruluş

Varsayılan olarak, API çağrılarının bağlamı kullanıcının varsayılan kuruluşu olacaktır. Başka bir kuruluşa hedeflenmek isterseniz, X-Kuruluş başlığını kullanabilirsiniz.

Curl ile:

curl -u <user>:<password> -H 'X-Organisation: myOrg' http://localhost:9000/api/v1/alert ...

Python istekleri ile:

headers = {'X-Organisation': 'myOrg'}
requests.post('http://localhost:9000/api/v1/alert', headers=headers, json=...)

Kimlik Doğrulama

 Api Anahtarı

Api anahtarı bir kullanıcı ayarlarından oluşturulabilir ve alınabilir. Daha sonra istek başlıklarında bir taşıyıcı belirtisi olarak sağlanması gerekir.

Örneğin curl ile:

curl -H 'Authorization: Bearer <API_KEY>' ...

• Güvenlik Şeması Türü HTTP
  
• HTTP Yetkilendirme Şeması taşıyıcısı

Temel

İstekin Yetkilendirme başlığında iletilen kullanıcı girişi ve parolasını kullanın.

Örneğin curl ile:

curl -u <login>:<password> ...

Oturum (Session)

Bu, kullanıcı bilgilerini çerezlerden alacaktır. Bu, TheHive'ın ön ucu tarafından kullanılır ve botlar ve otomasyon için uygun değildir. Bir kullanıcı giriş yaptıktan sonra (giriş/parola veya SSO ile) tarayıcıda THEHIVE-SESSION adında bir Çerez ayarlanır.

• Güvenlik Şeması Türü API Anahtarı
  
• Çerez parametre adı: THEHIVE-SESSION