REST API-khoz való hozzáférés engedélyezése az OAuth 2.0-val

  • Cikk

Azure DevOps Services

Megtudhatja, hogyan hitelesítheti a webalkalmazás felhasználóit a REST API-hozzáféréshez, így az alkalmazás továbbra sem kér felhasználóneveket és jelszavakat.

Megjegyzés:

  • Az alábbi útmutató az Azure DevOps Services felhasználóinak szól, mivel az OAuth 2.0 nem támogatott az Azure DevOps Serveren. Az ügyfélkódtárak olyan csomagok sorozatai, amelyek kifejezetten az Azure DevOps Server funkcióinak kiterjesztésére készültek. A helyszíni felhasználók számára javasoljuk, hogy ügyfélkódtárak, Windows-hitelesítés vagy személyes hozzáférési jogkivonatok (PAT-k) használatával hitelesítsék magukat a felhasználó nevében.
  • További információ: C# OAuth GitHub-minta.

Az OAuth 2.0 ismertetése

Az Azure DevOps Services az OAuth 2.0 protokoll használatával engedélyezi az alkalmazást egy felhasználó számára, és létrehoz egy hozzáférési jogkivonatot. Ezt a tokent akkor használja, amikor meghívja a REST API-kat az alkalmazásból. Amikor meghívja az adott felhasználóhoz tartozó Azure DevOps Services API-kat, használja a felhasználó hozzáférési tokenjét. A hozzáférési tokenek lejárnak, ezért ha lejárt, frissítse azt.

Process to get authorization.

Elérhető OAuth-modellek

OAuth 2.0-alkalmazás létrehozásakor használja a Microsoft Entra ID OAuth-ot. Továbbra is támogatjuk az Azure DevOps OAuth 2.0-t, de jelenleg nem fektetünk be ebbe a modellbe.

Microsoft Entra ID OAuth

Microsoft Entra ID OAuth-alkalmazás létrehozásakor az alkalmazás Microsoft Entra-jogkivonatokat ad ki, nem az Azure DevOps hozzáférési jogkivonatait. Ezek a jogkivonatok a lejárat előtt szabványos egyórás időtartamtal rendelkeznek.

For more information, see the following articles:

Megjegyzés:

Amikor más API-kat használó alkalmazásokat hoz létre, mindenképpen válassza ki az adott API-khoz szükséges hatóköröket .

Azure DevOps OAuth

Meglévő alkalmazások esetén használja az Azure DevOps OAuth útmutatót. Azt is kezelheti, hogy mely Azure DevOps-alkalmazások engedélyezettek.

Hatókörök

A fejlesztőknek várhatóan meg kell adniuk, hogy milyen hatóköröket igényelnek a felhasználóktól. A hatókörök mindkét OAuth-modellben elérhetők. A következő hatókörök csak delegált (felhasználó nevében) folyamatokon keresztül érhetők el. Ha meg szeretné tudni, hogy milyen hatókörökre van szüksége az alkalmazáshoz, tekintse meg az scopes egyes használt API-k api-referenciaoldalának fejlécét.

Egyes hatókörök tartalmazhatnak más hatóköröket is, code_manage például.code_write Vegye figyelembe, hogy milyen minimális számú hatókörre van szükség a felhasználóktól való hatókör-hozzájárulás kéréséhez.

Fontos

A hatókörök csak a REST API-k elérését teszik lehetővé, és a Git-végpontok kiválasztása. A SOAP API-hozzáférés nem támogatott.

Kategória Scope Name Leírás
Ügynökkészletek vso.agentpools Ügynökkészletek (olvasás) Lehetővé teszi a tevékenységek, készletek, üzenetsorok, ügynökök, valamint az ügynökök jelenleg futó vagy nemrég befejezett feladatainak megtekintését.
vso.agentpools_manage Ügynökkészletek (olvasás, kezelés) Lehetővé teszi készletek, üzenetsorok és ügynökök kezelését.
vso.environment_manage Környezet (olvasás, kezelés) Lehetővé teszi készletek, üzenetsorok, ügynökök és környezetek kezelését.
Elemzés vso.analytics Elemzés (olvasás) Lehetővé teszi az elemzési adatok lekérdezését.
Naplózás vso.auditlog Naplózási napló (olvasás) Lehetővé teszi a naplózási napló olvasását a felhasználóknak.
vso.auditstreams_manage Naplózási adatfolyamok (olvasás) Lehetővé teszi a naplózási streamek felhasználók számára történő kezelését.
Build vso.build Buildelés (olvasás) Lehetővé teszi a buildösszetevők, köztük a builderedmények, a definíciók és a kérések elérését, valamint a buildeseményekkel kapcsolatos értesítések szolgáltatáshookokon keresztüli fogadását.
vso.build_execute Buildelés (olvasás és végrehajtás) Lehetővé teszi a buildösszetevők( például a builderedmények, a definíciók és a kérések) elérését, valamint a buildek várólistára helyezését, a buildtulajdonságok frissítését, valamint a buildeseményekkel kapcsolatos értesítések fogadását szolgáltatáshookokon keresztül.
Kód vso.code Kód (olvasás) Lehetővé teszi a forráskód és a metaadatok olvasását a véglegesítésekről, a módosításkészletekről, az ágakról és más verziókövetési összetevőkről. Emellett lehetővé teszi a kódkeresést és a verziókövetési eseményekről való értesítést szolgáltatáshookokon keresztül.
vso.code_write Kód (olvasás és írás) Lehetővé teszi a forráskód olvasását, frissítését és törlését, a véglegesítések metaadatainak elérését, a módosításkészleteket, az ágakat és más verziókövetési összetevőket. Emellett lehetővé teszi a lekéréses kérelmek és a kódellenőrzések létrehozását és kezelését, valamint a verziókövetési eseményekről szóló értesítések fogadását szolgáltatáshookokon keresztül.
vso.code_manage Kód (olvasás, írás és kezelés) Lehetővé teszi a forráskód olvasását, frissítését és törlését, a véglegesítések metaadatainak elérését, a módosításkészleteket, az ágakat és más verziókövetési összetevőket. Emellett lehetővé teszi a kódtárak létrehozását és kezelését, a lekéréses kérelmek és a kódértékelések létrehozását és kezelését, valamint a verziókövetési eseményekről szóló értesítések fogadását szolgáltatáshookokon keresztül.
vso.code_full Kód (teljes) Teljes hozzáférést biztosít a forráskódhoz, a véglegesítések metaadataihoz, a módosításkészletekhez, az ágakhoz és más verziókövetési összetevőkhöz. Emellett lehetővé teszi a kódtárak létrehozását és kezelését, a lekéréses kérelmek és a kódértékelések létrehozását és kezelését, valamint a verziókövetési eseményekről szóló értesítések fogadását szolgáltatáshookokon keresztül. Emellett korlátozott támogatást is biztosít az ügyféloldali OM API-khoz.
vso.code_status Kód (állapot) Lehetővé teszi a véglegesítési és lekéréses kérelmek állapotának olvasását és írását.
Csatlakozás kiszolgáló vso.connected_server Csatlakozás kiszolgáló Lehetővé teszi a helyszíni csatlakoztatott kiszolgálóról szükséges végpontok elérését.
Jogosultságok vso.entitlements Jogosultságok (olvasás) Csak olvasási hozzáférést biztosít a licencjogosultságok végpontjához a fiókjogosultságok lekéréséhez.
vso.memberentitlementmanagement MemberEntitlement Management (olvasás) Lehetővé teszi a felhasználók, a licencek, valamint az általuk elérhető projektek és bővítmények olvasását.
vso.memberentitlementmanagement_write MemberEntitlement Management (írás) Lehetővé teszi a felhasználók, a licencek, valamint az általuk elérhető projektek és bővítmények kezelését.
Kiterjesztés vso.extension Bővítmények (olvasás) Lehetővé teszi a telepített bővítmények olvasását.
vso.extension_manage Bővítmények (olvasás és kezelés) Lehetővé teszi más felügyeleti műveletek telepítését, eltávolítását és végrehajtását a telepített bővítményeken.
vso.extension.data Bővítményadatok (olvasás) Lehetővé teszi a telepített bővítmények által tárolt adatok (beállítások és dokumentumok) olvasását.
vso.extension.data_write Bővítményadatok (olvasás és írás) Lehetővé teszi a telepített bővítmények által tárolt adatok (beállítások és dokumentumok) olvasását és írását.
Graph & identity vso.graph Gráf (olvasás) Lehetővé teszi a felhasználói, csoport-, hatókör- és csoporttagság-információk olvasását.
vso.graph_manage Gráf (kezelés) Lehetővé teszi a felhasználók, csoportok, hatókörök és csoporttagságok adatainak olvasását, valamint felhasználók, csoportok hozzáadását és csoporttagságok kezelését.
vso.identity Identitás (olvasás) Lehetővé teszi az identitások és csoportok olvasását.
vso.identity_manage Identitás (kezelés) Lehetővé teszi az identitások és csoportok olvasását, írását és kezelését.
Gépcsoport vso.machinegroup_manage Üzembe helyezési csoport (olvasás, kezelés) Lehetővé teszi az üzembehelyezési csoport és az ügynökkészletek kezelését.
Piactér vso.gallery Piactér Olvasási hozzáférést biztosít a nyilvános és privát elemekhez és közzétevőkhöz.
vso.gallery_acquire Marketplace (beszerzés) Olvasási hozzáférést és elemek beszerzését teszi lehetővé.
vso.gallery_publish Marketplace (közzététel) Olvasási hozzáférést biztosít, valamint lehetővé teszi elemek feltöltését, frissítését és megosztását.
vso.gallery_manage Marketplace (kezelés) Olvasási hozzáférést biztosít, valamint lehetővé teszi az elemek és közzétevők közzétételét és kezelését.
Notifications vso.notification Értesítések (olvasás) Olvasási hozzáférést biztosít az előfizetésekhez és az esemény metaadataihoz, beleértve a szűrhető mezőértékeket is.
vso.notification_write Értesítések (írás) Olvasási és írási hozzáférést biztosít az előfizetésekhez, és olvasási hozzáférést biztosít az esemény metaadataihoz, beleértve a szűrhető mezőértékeket is.
vso.notification_manage Értesítések (kezelés) Olvasási, írási és felügyeleti hozzáférést biztosít az előfizetésekhez, és olvasási hozzáférést biztosít az esemény metaadataihoz, beleértve a szűrhető mezőértékeket is.
vso.notification_diagnostics Értesítések (diagnosztika) Hozzáférést biztosít az értesítésekkel kapcsolatos diagnosztikai naplókhoz, és lehetővé teszi az egyes előfizetések diagnosztikáinak engedélyezését.
Csomagolás vso.packaging Csomagolás (olvasás) Lehetővé teszi a hírcsatornák és csomagok olvasását.
vso.packaging_write Csomagolás (olvasás és írás) Lehetővé teszi hírcsatornák és csomagok létrehozását és olvasását.
vso.packaging_manage Csomagolás (olvasás, írás és kezelés) Lehetővé teszi hírcsatornák és csomagok létrehozását, olvasását, frissítését és törlését.
Folyamaterőforrások vso.pipelineresources_use Folyamaterőforrások (használat) Lehetővé teszi egy folyamat védett erőforrás használatára vonatkozó kérésének jóváhagyását: ügynökkészlet, környezet, üzenetsor, adattár, biztonságos fájlok, szolgáltatáskapcsolat és változócsoport.
vso.pipelineresources_manage Folyamaterőforrások (használat és kezelés) Lehetővé teszi védett erőforrás vagy folyamat védett erőforrás használatára vonatkozó kérésének kezelését: ügynökkészlet, környezet, üzenetsor, adattár, biztonságos fájlok, szolgáltatáskapcsolat és változócsoport.
Projekt és csapat vso.project Projekt és csapat (olvasás) Lehetővé teszi projektek és csapatok olvasását.
vso.project_write Projekt és csapat (olvasás és írás) Lehetővé teszi a projektek és csapatok olvasását és frissítését.
vso.project_manage Projekt és csapat (olvasás, írás és kezelés) Lehetővé teszi projektek és csapatok létrehozását, olvasását, frissítését és törlését.
Kiadás vso.release Kiadás (olvasás) Lehetővé teszi a kiadási összetevők olvasását, beleértve a kiadásokat, a kiadási definíciókat és a kiadási környezetet.
vso.release_execute Kiadás (olvasás, írás és végrehajtás) Lehetővé teszi a kiadási összetevők olvasását és frissítését, beleértve a kiadásokat, a kiadási definíciókat és a kiadási környezetet, valamint az új kiadások várólistára helyezésének lehetőségét.
vso.release_manage Kiadás (olvasás, írás, végrehajtás és kezelés) Lehetővé teszi a kiadási összetevők olvasását, frissítését és törlését, beleértve a kiadásokat, a kiadási definíciókat és a kiadási környezetet, valamint az új kiadások várólistára helyezését és jóváhagyását.
Biztonságos fájlok vso.securefiles_read Biztonságos fájlok (olvasás) Lehetővé teszi a biztonságos fájlok olvasását.
vso.securefiles_write Biztonságos fájlok (olvasás, létrehozás) Lehetővé teszi a biztonságos fájlok olvasását és létrehozását.
vso.securefiles_manage Biztonságos fájlok (olvasás, létrehozás és kezelés) Lehetővé teszi a biztonságos fájlok olvasását, létrehozását és kezelését.
Biztonság vso.security_manage Biztonság (kezelés) Lehetővé teszi a biztonsági engedélyek olvasását, írását és kezelését.
Szolgáltatáskapcsolatok vso.serviceendpoint Szolgáltatásvégpontok (olvasás) Lehetővé teszi a szolgáltatásvégpontok olvasását.
vso.serviceendpoint_query Szolgáltatásvégpontok (olvasás és lekérdezés) Lehetővé teszi a szolgáltatásvégpontok olvasását és lekérdezését.
vso.serviceendpoint_manage Szolgáltatásvégpontok (olvasás, lekérdezés és kezelés) Lehetővé teszi a szolgáltatásvégpontok olvasását, lekérdezését és kezelését.
Beállítások vso.settings Gépház (olvasás) Lehetővé teszi a beállítások olvasását.
vso.settings_write Gépház (olvasás és írás) Lehetővé teszi a beállítások létrehozását és olvasását.
Szimbólumok vso.symbols Szimbólumok (olvasás) Lehetővé teszi a szimbólumok olvasását.
vso.symbols_write Szimbólumok (olvasás és írás) Lehetővé teszi szimbólumok olvasását és írását.
vso.symbols_manage Szimbólumok (olvasás, írás és kezelés) Lehetővé teszi a szimbólumok olvasását, írását és kezelését.
Tevékenységcsoportok vso.taskgroups_read Tevékenységcsoportok (olvasás) Lehetővé teszi a feladatcsoportok olvasását.
vso.taskgroups_write Tevékenységcsoportok (olvasás, létrehozás) Lehetővé teszi a tevékenységcsoportok olvasását és létrehozását.
vso.taskgroups_manage Tevékenységcsoportok (olvasás, létrehozás és kezelés) Lehetővé teszi a munkacsoportok olvasását, létrehozását és kezelését.
Csapat irányítópultja vso.dashboards Csapat irányítópultjai (olvasás) Lehetővé teszi a csapat irányítópultjának információinak olvasását.
vso.dashboards_manage Csapat irányítópultjai (kezelés) Lehetővé teszi a csapat irányítópult-adatainak kezelését.
Tesztkezelés vso.test Tesztkezelés (olvasás) Lehetővé teszi a teszttervek, esetek, eredmények és más, tesztkezeléssel kapcsolatos összetevők olvasását.
vso.test_write Tesztkezelés (olvasás és írás) Lehetővé teszi a teszttervek, esetek, eredmények és más tesztkezeléssel kapcsolatos összetevők olvasását, létrehozását és frissítését.
Szálak vso.threads_full PR-szálak Olvasási és írási lehetőséget biztosít a kérések megjegyzésszálainak lekéréséhez.
Jogkivonatok vso.tokens Delegált engedélyezési jogkivonatok Lehetővé teszi a felhasználók számára delegált engedélyezési jogkivonatok kezelését.
vso.tokenadministration Token Rendszergazda istration Lehetővé teszi a meglévő jogkivonatok kezelését (megtekintését és visszavonását) a szervezet rendszergazdái számára.
Felhasználói profil vso.profile Felhasználói profil (olvasás) Lehetővé teszi a profil, a fiókok, a gyűjtemények, a projektek, a csapatok és más legfelső szintű szervezeti összetevők olvasását.
vso.profile_write Felhasználói profil (írás) Lehetővé teszi a profilba való írást.
Változócsoportok vso.variablegroups_read Változócsoportok (olvasás) Lehetővé teszi a változócsoportok olvasását.
vso.variablegroups_write Változócsoportok (olvasás, létrehozás) Lehetővé teszi változócsoportok olvasását és létrehozását.
vso.variablegroups_manage Változócsoportok (olvasás, létrehozás és kezelés) Lehetővé teszi a változócsoportok olvasását, létrehozását és kezelését.
Wiki vso.wiki Wiki (olvasás) Lehetővé teszi a wikik, wikilapok és wikimellékletek olvasását. Emellett lehetővé teszi a wikilapok keresését is.
vso.wiki_write Wiki (olvasás és írás) Lehetővé teszi a wikik, wikilapok és wikimellékletek olvasását, létrehozását és frissítését.
Munkaelemek vso.work Munkaelemek (olvasás) Lehetővé teszi a munkaelemek, lekérdezések, táblák, terület- és iterációs útvonalak és egyéb munkaelemek nyomon követésével kapcsolatos metaadatok olvasását. Emellett lehetővé teszi a lekérdezések végrehajtását, a munkaelemek keresését és a munkaelemek eseményeiről szóló értesítések fogadását szolgáltatáshookokon keresztül.
vso.work_write Munkaelemek (olvasás és írás) Lehetővé teszi a munkaelemek és lekérdezések olvasását, létrehozását és frissítését, a tábla metaadatainak frissítését, az olvasási területet és az iterációkat, valamint a munkaelemek nyomon követésével kapcsolatos egyéb metaadatok elérési útját, lekérdezéseket hajthat végre, és szolgáltatáshookokon keresztül értesítéseket kaphat a munkaelem-eseményekről.
vso.work_full Munkaelemek (megtelt) Teljes hozzáférést biztosít a munkaelemekhez, lekérdezésekhez, hátralékokhoz, tervekhez és munkaelem-követési metaadatokhoz. Emellett lehetővé teszi a munkahelyi elemek eseményeiről szóló értesítések fogadását szolgáltatáshookokon keresztül.
Felhasználói megszemélyesítés user_impersonation Felhasználói megszemélyesítés Teljes hozzáféréssel rendelkezik a Visual Studio Team Services REST API-khoz. Kérje és/vagy hagyja jóvá ezt a hatókört óvatosan, mivel nagyon hatékony!