Biztonságos hozzáférés az API Management fejlesztői portáljához

A KÖVETKEZŐKRE VONATKOZIK: Fejlesztő | Alapszintű | Alapszintű v2 | Standard | Standard v2 | Prémium | Prémium v2

Az API Management egy teljesen testre szabható, önálló, felügyelt fejlesztői portállal rendelkezik, amely külsőleg (vagy belsőleg) is használható annak érdekében, hogy a fejlesztői felhasználók felfedezhessék és interakcióba léphessenek az API Managementen keresztül közzétett API-kkal. A fejlesztői portál számos lehetőséget kínál a biztonságos felhasználói regisztráció és bejelentkezés megkönnyítésére.

Megjegyzés

A fejlesztői portál alapértelmezés szerint engedélyezi a névtelen hozzáférést. Ez az alapértelmezett beállítás azt jelenti, hogy bárki bejelentkezés nélkül megtekintheti a portált és az olyan tartalmakat, mint az API-k, bár az olyan funkciók, mint a tesztkonzol használata, korlátozottak. Engedélyezheti azokat a beállításokat, amelyekhez a felhasználóknak be kell jelentkeznie a fejlesztői portál megtekintéséhez. Az Azure Portalon, az API Management-példány bal oldali menüjében, a Fejlesztői portál alatt válassza az Identitások, >, Beállítások lehetőséget. A Névtelen felhasználók csoportban válassza a Névtelen felhasználók átirányítása a bejelentkezési lapra (engedélyezés) lehetőséget.

Hitelesítési lehetőségek

  • Belső felhasználók – A belső felhasználók számára a fejlesztői portálhoz való hozzáférés engedélyezéséhez használja a vállalati (munkaerő) Microsoft Entra ID bérleményt. A Microsoft Entra ID zökkenőmentes egyszeri bejelentkezést (SSO) biztosít azoknak a vállalati felhasználóknak, akiknek api-kat kell elérnie és felderítenie a fejlesztői portálon keresztül.

    A Microsoft Entra-hitelesítés fejlesztői portálon való engedélyezésének lépéseit a fejlesztői fiókok Microsoft Entra-azonosítóval történő engedélyezésével az Azure API Managementben című témakörben találja.

  • Külső felhasználók – Ha engedélyezni szeretné a külső felhasználók számára a fejlesztői portálhoz való hozzáférést, konfigurálhatja a külső identitásszolgáltatókat a Microsoft Entra ID munkaerő-bérlőjében. Előfordulhat például, hogy azt szeretné, hogy a felhasználók meglévő közösségimédia-fiókok használatával regisztráljanak és jelentkezzenek be a fejlesztői portálra. További információ: Külső felhasználók hozzáférésének engedélyezése a Microsoft Entra-azonosító bérlőjében.

    Megjegyzés

    Az API Management régi támogatást nyújt az Azure Active Directory B2C-hez külső identitásszolgáltatóként. Javasoljuk azonban, hogy az API Management fejlesztői portál új üzembe helyezéséhez az Azure Active Directory B2C helyett külső identitásszolgáltatóként használja a Microsoft Entra Külső azonosítót.

    Fontos

    2025. május 1-jére az Azure AD B2C már nem lesz elérhető az új ügyfelek számára. További információ a GYIK-ben.

  • Alapszintű hitelesítés – Használja a beépített fejlesztői portál felhasználónevét és jelszószolgáltatóját . Ez a beállítás lehetővé teszi a fejlesztők számára, hogy közvetlenül regisztráljanak az API Managementben, és API Management felhasználói fiókok használatával jelentkezzenek be. Az ezen a beállításon keresztüli felhasználóregisztrációt egy CAPTCHA-szolgáltatás védi.

    Figyelemfelhívás

    Bár alapszintű hitelesítéssel biztosíthatja a felhasználók hozzáférését a fejlesztői portálhoz, javasoljuk, hogy konfiguráljon egy biztonságosabb hitelesítési módszert, például a Microsoft Entra ID-t.

Fejlesztői portál tesztkonzolja

Amellett, hogy konfigurációt biztosít a fejlesztői felhasználóknak a hozzáférésre való regisztrációhoz és a bejelentkezéshez, a fejlesztői portál egy tesztkonzolt is tartalmaz, ahol a fejlesztők az API Managementen keresztül küldhetnek tesztkéréseket a háttér api-knak. Ez a tesztkörnyezet az API Management azon közreműködő felhasználói számára is létezik, akik az Azure Portal használatával kezelik a szolgáltatást.

Ha az Azure API Managementen keresztül közzétett API-t az OAuth 2.0-val védi – vagyis egy hívó alkalmazásnak (tulajdonosnak) érvényes hozzáférési jogkivonatot kell beszereznie és átadnia –, konfigurálhatja az API Managementet úgy, hogy érvényes jogkivonatot hozzon létre egy Azure Portal vagy egy fejlesztői portál tesztkonzol-felhasználója nevében. További információ: Hogyan engedélyezheti a fejlesztői portál tesztkonzolját az OAuth 2.0 felhasználói engedélyezésének konfigurálásával.

Ha engedélyezni szeretné, hogy a tesztkonzol érvényes OAuth 2.0-jogkivonatot szerezzen be az API-teszteléshez:

  1. Adjon hozzá egy OAuth 2.0 felhasználói engedélyezési kiszolgálót a példányhoz. Bármely OAuth 2.0-szolgáltatót használhat, beleértve a Microsoft Entra ID-t, a Microsoft Entra külső azonosítót vagy egy külső identitásszolgáltatót.

  2. Konfigurálja az API-t az engedélyezési kiszolgáló beállításaival. A portálon konfigurálja az OAuth 2.0-s engedélyezést az API Beállítások lapján, Biztonság és Felhasználói engedélyezés.

    Képernyőkép egy API OAuth-beállításairól a portálon.

Az API-teszteléshez használt OAuth 2.0-konfiguráció független a fejlesztői portálhoz való felhasználói hozzáféréshez szükséges konfigurációtól. Az identitásszolgáltató és a felhasználó azonban ugyanaz lehet. Egy intranetes alkalmazás például az egyszeri bejelentkezés és a vállalati identitás használatával megkövetelheti a felhasználói hozzáférést a fejlesztői portálhoz. Ugyanez a vállalati identitás a tesztkonzolon keresztül beszerezhet egy jogkivonatot, amelyet a háttérszolgáltatás ugyanazzal a felhasználói környezettel való meghívására használhat.

Forgatókönyvek

A különböző hitelesítési és engedélyezési lehetőségek különböző forgatókönyvekre vonatkoznak. Az alábbi szakaszok három példaforgatókönyv magas szintű konfigurációit ismertetik. További lépéseket kell tennie az API Management által közzétett API-k teljes körű védelméhez és konfigurálásához. A forgatókönyvek azonban szándékosan az egyes esetekben javasolt minimális konfigurációkra összpontosítanak a szükséges hitelesítés és engedélyezés biztosításához.

1. forgatókönyv – Intranetes API és alkalmazások

  • Az API Management közreműködője és háttér API-fejlesztője közzé szeretne tenni egy OAuth 2.0 által védett API-t.
  • Az API-t olyan asztali alkalmazások használják, amelyek felhasználói egyszeri bejelentkezéssel jelentkeznek be a Microsoft Entra-azonosítón keresztül.
  • Az asztali alkalmazásfejlesztőknek az API Management fejlesztői portálon keresztül kell felderítenie és tesztelnie az API-kat.

Kulcskonfigurációk:

Konfiguráció Referencia
Az API Management fejlesztői portál fejlesztői felhasználóinak engedélyezése a vállalati identitásuk és a Microsoft Entra-azonosítójuk használatával. Fejlesztői fiókok engedélyezése a Microsoft Entra ID használatával az Azure API-kezelésben
Állítsa be a tesztkonzolt a fejlesztői portálon, hogy érvényes OAuth 2.0-jogkivonatot szerezzen be az asztali alkalmazás fejlesztőinek a háttér API használatára.

Ugyanez a konfiguráció használható a tesztkonzolhoz az Azure Portalon, amely az API Management közreműködői és a háttérfejlesztők számára érhető el.

A jogkivonat egy API Management-előfizetési kulccsal kombinálva használható.		 A fejlesztői portál tesztkonzoljának engedélyezése az OAuth 2.0 felhasználói engedélyezésének konfigurálásával

Előfizetések az Azure API Managementben
Ellenőrizze az OAuth 2.0 jogkivonatot és jogcímeket, ha egy API-t az API Managementen keresztül hív meg hozzáférési jogkivonattal. JWT-szabályzat ellenőrzése

Ezzel a forgatókönyvvel egy lépéssel továbbhaladhat az API Management hálózati szegélyhálózatra való áthelyezésével és a bejövő forgalom fordított proxyn keresztüli szabályozásával. Referenciaarchitektúra : API-k védelme az Application Gateway és az API Management használatával.

2. forgatókönyv – Külső API, partneralkalmazás

  • Az API Management közreműködője és háttér API-fejlesztője gyorsan létre szeretne hozni egy megvalósíthatósági igazolást az örökölt API-k Azure API Managementen keresztüli felfedéséhez. Az API az API Managementen keresztül külsőleg (internetkapcsolattal) érhető el.
  • Az API ügyféltanúsítvány-hitelesítést használ, és egy partner által külföldön fejlesztett, nyilvános elérésű új egyoldalas alkalmazás (SPA) használja.
  • Az SPA az OAuth 2.0-t használja az OpenID Connect (OIDC) használatával.
  • Az alkalmazásfejlesztők a fejlesztői portálon keresztül férnek hozzá az API-hoz egy tesztkörnyezetben, egy tesztháttér-végpont használatával felgyorsítva az előtérbeli fejlesztést.

Kulcskonfigurációk:

Konfiguráció Referencia
Konfigurálja az előtérbeli fejlesztői hozzáférést a fejlesztői portálhoz az alapértelmezett felhasználónév és jelszóhitelesítés használatával.

A fejlesztők a fejlesztői portálra is meghívhatók.		 A fejlesztői portál felhasználóinak konfigurálása felhasználónevek és jelszavak használatával történő hitelesítéshez

Felhasználói fiókok kezelése az Azure API Managementben
Ellenőrizze az OAuth 2.0 jogkivonatot és jogcímeket, amikor az SPA hozzáférési jogkivonattal hívja meg az API Managementet. Ebben az esetben a célközönség az API Management. JWT-szabályzat ellenőrzése
Az API Management beállítása ügyféltanúsítvány-hitelesítés használatára a háttérrendszerben. Háttérszolgáltatások védelme ügyféltanúsítvány-hitelesítéssel az Azure API Managementben

A forgatókönyv továbbfejlesztéséhez használja a fejlesztői portált a Microsoft Entra engedélyezésével és a Microsoft Entra B2B együttműködésével , hogy a kézbesítési partnerek szorosabban együttműködhessenek. Fontolja meg az API Managementhez való hozzáférés RBAC-vel való delegálását fejlesztési vagy tesztelési környezetben, és engedélyezze az egyszeri bejelentkezést a fejlesztői portálon a saját vállalati hitelesítő adataik használatával.

3. forgatókönyv – Nyilvánosan megnyitott külső API, az SaaS

  • Az API Management közreműködője és háttér API-fejlesztője számos új API-t ír, amelyeket a közösségi fejlesztők használhatnak.

  • Az API-k nyilvánosan elérhetők, de a teljes funkcionalitást egy fizetőfal védi, és az OAuth 2.0 használatával védi. A licenc megvásárlása után a fejlesztő saját ügyfél-hitelesítő adatokat és az éles használatra érvényes előfizetési kulcsot kap.

  • A külső közösségi fejlesztők a fejlesztői portálon fedezhetik fel az API-kat. A fejlesztők közösségimédia-fiókjukkal regisztrálnak és bejelentkeznek a fejlesztői portálra.

  • A teszt-előfizetési kulccsal rendelkező érdeklődő fejlesztői portál felhasználói tesztkörnyezetben fedezhetik fel az API funkcióit anélkül, hogy licencet kellene vásárolniuk. A fejlesztői portál tesztkonzolja a hívó alkalmazást jelöli, és létrehoz egy alapértelmezett hozzáférési jogkivonatot a háttér API-hoz.

    Figyelemfelhívás

    A fejlesztői portál tesztkonzolján az ügyfél hitelesítő adatainak használata esetén fokozott óvatosságra van szükség. Tekintse meg a biztonsági szempontokat.

Kulcskonfigurációk:

Konfiguráció Referencia
Állítson be termékeket az Azure API Managementben a közösségi fejlesztők számára közzétett API-k kombinációinak megjelenítéséhez.

Előfizetések beállítása, amelyek lehetővé teszik a fejlesztők számára az API-k használatát.		 Oktatóanyag: Termék létrehozása és közzététele

Előfizetések az Azure API Managementben
Konfigurálja a fejlesztői portálhoz való közösségi fejlesztői hozzáférést a Microsoft Entra külső azonosítójával. A Microsoft Entra külső azonosítója ezután konfigurálható úgy, hogy egy vagy több alsóbb rétegbeli közösségimédia-identitásszolgáltatóval működjön együtt. Fejlesztői fiókok engedélyezése a Microsoft Entra külső azonosítójával az Azure API Managementben
Állítsa be a tesztkonzolt a fejlesztői portálon, hogy érvényes OAuth 2.0-jogkivonatot szerezzen be a háttér API-hoz az ügyfél hitelesítő adatainak folyamatával. A fejlesztői portál tesztkonzoljának engedélyezése az OAuth 2.0 felhasználói engedélyezésének konfigurálásával

Módosítsa az ebben a cikkben látható konfigurációs lépéseket úgy, hogy az engedélyezési kód engedélyezési folyamata helyett az ügyfél hitelesítő adatait adja meg.

Egy lépéssel továbbhaladhat a felhasználói regisztráció vagy a termék-előfizetés delegálásával, és kibővítheti a folyamatot a saját logikájával.

Kapcsolódó tartalom

  • Last updated on