Erişim anahtarları

Entegrasyon anahtarlarını okuma, yazma ve proje kapsamıyla oluşturun ve iptal edin.

Son güncelleme:

Bu sayfadaYetki modeliAnahtar oluşturmaListeleme ve iptal

Yetki modeli

Erişim anahtarı bir kurum kullanıcısına bağlıdır. Kullanıcının güncel rolü, kurum durumu, proje üyeliği, modül ve bölge izinleri her istekte yeniden değerlendirilir. Anahtar kullanıcının yetkisini genişletmez. İzleyici yalnız okuma anahtarı oluşturabilir; kurumdan bağımsız süper yönetici bu akıştan anahtar oluşturamaz.

Anahtar yönetimi /api/anahtarlar altında kullanıcı oturumuyla yapılır. Anahtarın kendisi v1 API ve OGC isteklerinde kullanılır.

Anahtar oluşturma

  1. Kullanıcı oturumunu açın.
  2. Anlamlı bir ad, gerekli kapsam ve proje seçimini belirleyin.
  3. POST /api/anahtarlar çağrısını gönderin.
  4. 201 yanıtındaki sir değerini kaydedin. Bu değer yalnız oluşturma yanıtında gösterilir; listeleme onu geri vermez.
  5. GET /api/v1/me çağrısıyla anahtarın kimliğini kontrol edin.
{
  "ad": "Envanter okuma",
  "kapsam": ["oku"],
  "proje_ids": [123],
  "bitis_at": null
}

123 örnek proje kimliğidir. kapsam yalnız ["oku"] veya ["oku", "yaz"] olabilir. proje_ids: null, kullanıcının erişebildiği projelerle sınırlı genel kapsamı; boş dizi hiçbir projeye erişmemeyi belirtir. Proje kimlikleri tekrarsız olmalıdır.

bitis_at boş bırakılabilir. Verilirse saat dilimli tarih gelecekte ve en fazla 730 gün sonra olmalıdır. Ad 1–64 karakterdir; kullanıcı başına en fazla 20 etkin anahtar oluşturulabilir.

Listeleme ve iptal

Yöntem ve uç İşlev
GET /api/anahtarlar Oturum sahibinin anahtarlarını listeler
GET /api/anahtarlar?org=1 Kurum yöneticisinin kurum anahtarlarını görmesini sağlar
DELETE /api/anahtarlar/{aid} Anahtarı iptal eder; başarı yanıtı 204

Listede kimlik, ad, onek, kapsam, proje kimlikleri, bitiş, son kullanım ve iptal zamanları bulunur. Tam sır ve özeti listelenmez. Kullanıcı kendi anahtarını, kurum yöneticisi aynı kurumun anahtarını iptal edebilir.

Kapsamı değiştirmek için uygun kapsamda yeni anahtar üretin, entegrasyonu yeni anahtara geçirin ve eski anahtarı iptal edin. Kullanıcı veya kurumun etkinliği sona erdiğinde ya da anahtarın süresi dolduğunda anahtar çalışmaz. Eski anahtarın yeniden kullanılabileceğini varsaymayın.