Kapsamlı API anahtarları

paket dağıtımı için daha güvenli bir ortam NuGet sağlamak üzere kapsamlar ekleyerek apı anahtarlarının denetimini alabilirsiniz.

API Anahtarlarınıza kapsam sağlama özelliği, API 'lerinize daha iyi denetim sağlar. Seçenekleriniz şunlardır:

• Değişen süre sonu zaman çerçevelerine sahip farklı paketler için kullanılabilen birden çok kapsamlı API anahtarı oluşturun.
• API anahtarlarını güvenli bir şekilde edinin.
• Paket uygulanabilirliğini değiştirmek için mevcut API anahtarlarını düzenleyin.
• Diğer anahtarları kullanarak işlemleri etkilemeden mevcut API anahtarlarını yenileyin veya silin.

Neden kapsamlı API anahtarlarını destekliyoruz?

Daha ayrıntılı izinleriniz olmasını sağlamak için API anahtarları için kapsamları destekliyoruz. daha önce, NuGet bir hesap için tek bir apı anahtarı önerdi ve bu yaklaşım birkaç dezavantaja sahipti:

• Tüm paketleri denetlemek Için BIR API anahtarı. Tüm paketleri yönetmek için kullanılan tek bir API anahtarı ile, birden çok geliştirici farklı paketlere dahil edildiğinde ve bir yayımcı hesabını paylaştıklarında, anahtarı güvenli bir şekilde paylaşmak zordur.
• Tüm izinler veya hiçbiri. API anahtarına erişimi olan herkes, paketler üzerinde tüm izinlere (yayımlama, gönderme ve kaldırma) sahiptir. Bu, genellikle birden çok ekibin bulunduğu ortamda istenmez.
• Tek hata noktası. Tek bir API anahtarı aynı zamanda tek bir hata noktası anlamına gelir. Anahtar tehlikeye girerse, hesapla ilişkili tüm paketlerin güvenliği tehlikeye girebilir. API anahtarını yenilemek, sızıntıyı eklemenin ve CI/CD iş akışınıza kesintiye uğramaktan kaçınmanın tek yoludur. Ayrıca, bir kişiye ait API anahtarına erişimi iptal etmek istediğiniz durumlar olabilir (örneğin, bir çalışan kuruluştan ayrıldığında). Bunu bugün işlemek için temiz bir yol yoktur.

Kapsamlı API anahtarları sayesinde bu sorunları gidermek için mevcut iş akışlarının hiçbirini bozmadığından emin olun.

API anahtarı alma

1. NuGet.org hesabınızda oturum açın veya henüz yoksa bir hesap oluşturun.

   Hesabınızı oluşturma hakkında daha fazla bilgi için bkz. bireysel hesaplar.

2. Kullanıcı adınızı (sağ üst köşedeki) seçin ve ardından API anahtarları' nı seçin.

3. Oluştur' u seçin, anahtarınız için bir ad girin, kapsamları Gönder' i seçin. Glob deseninin* girin ve ardından Oluştur' u seçin. (Kapsamlar hakkında daha fazla bilgi için aşağıya bakın.)

4. Anahtar oluşturulduktan sonra, CLı 'de ihtiyacınız olan erişim anahtarını almak için Kopyala ' yı seçin:

   

Kapsam oluşturma, farklı amaçlar için ayrı API anahtarları oluşturmanıza olanak sağlar. Her anahtarın süre sonu zaman çerçevesi vardır ve belirli paketlere (veya glob desenlerine) kapsamı atanabilir. Her anahtar Ayrıca belirli işlemlere göre kapsamlandırılır: yeni paketleri ve güncelleştirmeleri gönderme, yalnızca güncelleştirmelerin gönderimi veya listesini kaldırma. Kapsam aracılığıyla, kuruluşunuzda yalnızca ihtiyaç duydukları izinlere sahip olmaları için paketleri yöneten farklı kişiler için API anahtarları oluşturabilirsiniz. Daha fazla bilgi için bkz. KAPSAMLı API anahtarları.

Kapsamlı API anahtarları oluşturma

Gereksinimlerinize göre birden çok API anahtarı oluşturabilirsiniz. Bir API anahtarı bir veya daha fazla pakete uygulanabilir, belirli ayrıcalıklar veren ve bunlarla ilişkili bir sona erme tarihi olan farklı kapsamlara sahip olabilir.

Aşağıdaki örnekte, Contoso service CI belirli paketlere yönelik paketleri göndermek için kullanılabilecek adlı BIR API anahtarınız vardır Contoso.Service ve 365 gün için geçerlidir. Bu, aynı kuruluştaki farklı takımların farklı paketlerde çalıştığı tipik bir senaryodur ve takımın üyelerine, yalnızca üzerinde çalıştıkları paket için kendilerine ayrıcalık veren anahtarı sağlarlar. Süre sonu eski veya unutulan anahtarları önleme mekanizması olarak görev yapar.

Glob desenlerini kullanma

Birden çok paket üzerinde çalışıyorsanız ve yönetmek üzere büyük bir paket listeniz varsa, birden fazla paketi birlikte seçmek için glob desenlerini kullanmayı seçebilirsiniz. Örneğin, KIMLIĞI ile başlayan tüm paketler için bir anahtara belirli kapsamlar vermek isterseniz Fabrikam.Service , bunu, fabrikam.service.*Fabrikam.Service metin kutusunda belirterek yapabilirsiniz.

API anahtarı izinlerinin belirlenmesi için glob desenlerinin kullanılması, glob deseniyle eşleşen yeni paketler için de geçerlidir. Örneğin, adlı yeni bir paket göndermeye çalışırsanız Fabrikam.Service.Framework , paket glob düzeniyle eşleştiğinden bu anahtarı daha önce oluşturulan anahtarla yapabilirsiniz fabrikam.service.* .

API anahtarlarını güvenli bir şekilde edinin

Güvenlik için, yeni oluşturulan bir anahtar ekranda hiçbir şekilde gösterilmez ve yalnızca Kopyala düğmesi kullanılarak kullanılabilir. Benzer şekilde, sayfa yenilendikten sonra anahtara erişilemez.

Mevcut API anahtarlarını Düzenle

Anahtarı değiştirmeden anahtar izinlerini ve kapsamları da güncelleştirmek isteyebilirsiniz. Tek bir paket için belirli kapsamlarla bir anahtarınız varsa, aynı kapsamları bir veya daha fazla pakete uygulamayı seçebilirsiniz.

Mevcut API anahtarlarını yenileme veya silme

Hesap sahibi anahtarı yenilemeyi seçebilir ve bu durumda izin (paketlerdeki), kapsam ve süre sonu aynı kalır, ancak eski anahtarı kullanılamaz hale getirmek için yeni bir anahtar verilir. Bu, eski anahtarları yönetirken veya bir API anahtarı sızıntısı için olası bir sorun olduğu durumlarda faydalıdır.

Artık gerekmiyorsa bu anahtarları silmeyi de tercih edebilirsiniz. Anahtar silindiğinde anahtar kaldırılır ve kullanılamaz hale gelir.

SSS

Eski (eski) API anahtarım için ne olur?

Eski API anahtarınız (eski) çalışmaya devam eder ve çalışmasını istediğiniz sürece çalışabilir. Ancak, bir paketi göndermek için 365 günden daha uzun bir süre kullanılmadığından bu anahtarlar devre dışı bırakılır. Daha ayrıntılı bilgi için bkz. blog gönderisi süresi dolan API anahtarları. Bu anahtarı artık yenileyemezsiniz. Bunun yerine eski anahtarı silmeniz ve yeni bir kapsamlı anahtar oluşturmanız gerekir.

Kaç tane API anahtarı oluşturabilirim?

Oluşturabileceğiniz API anahtarı sayısı için bir sınır yoktur. Bununla birlikte, bu süreyi yönetilebilir bir sayıya tutmanızı öneririz; Böylece, nerede ve kim tarafından kullanıldığı hakkında bilgi sahibi olmadan çok sayıda eski anahtara sahip olabilirsiniz.

Eski API anahtarımı silebilir veya şimdi kullanmaya devam edebilir miyim?

Evet. Ve büyük olasılıkla eski API anahtarınızı silmeniz gerekir.

Yanlışlıkla sildiğim API anahtarımı geri alabilir miyim?

Hayır. Silindikten sonra yalnızca yeni anahtarlar oluşturabilirsiniz. Yanlışlıkla silinen anahtarlar için bir kurtarma mümkün değildir.

Eski API anahtarı API anahtarı yenileme sonrasında çalışmaya devam eder mi?

Hayır. Bir anahtarı yeniledikten sonra, eskisiyle aynı kapsam, izin ve süre sonu olan yeni bir anahtar oluşturulur. Eski anahtar mevcut olmaya sona erer.

Var olan bir API anahtarına daha fazla izin verebilir miyim?

Kapsamı değiştiremezsiniz, ancak geçerli olduğu paket listesini düzenleyebilirsiniz.

Nasıl yaparım? anahtarlarım zaman aşımına uğradı veya zaman aşımına uğradı.

Herhangi bir anahtarın süresi dolarsa, sayfanın üst kısmında bir uyarı iletisi aracılığıyla size bilgi vereceğiz. Ayrıca, anahtar sona ermeden önce bir uyarı e-postası göndeririz ve bu sayede, daha iyi bir şekilde hareket edebilirsiniz.