Microsoft Entra ID Windows Account Manager (WAM) API-referencia
A Microsoft Entra ID Windows Account Manager (WAM) olyan API-k készlete, amelyek lehetővé teszik a fejlesztők számára a Windows-alkalmazások integrálását. Az alábbi paraméterek az MSAL használatával használhatók Windows-platformon, megkönnyítve az olyan alkalmazások fejlesztését, amelyek lehetővé teszik a felhasználók számára a Bejelentkezést a Microsoft Entra ID-n vagy a Microsoft-fiókokon (MSA) keresztül.
Microsoft Entra ID WAM API-referencia
Paraméter | Érték | Jegyzetek |
---|---|---|
authority |
Vagy organizations egy adott jogkivonatkibocsátó URL-címe. Például https://login.partner.microsoftonline.cn a felhőkörnyezet tokenkibocsátóJÁNAK URL-címe. |
A authority paraméter megadja az API identitásszolgáltatóját és felhőkörnyezetét. |
resource |
Az URL-cím, amelyhez a fejlesztő jogkivonatot szerez be, például https://www.sharepoint.com |
A resource paraméter megadja azt a cél URL-címet, amelyhez a hitelesítési jogkivonatot lekérte. |
redirect_uri |
Az a hely, ahol az engedélyezési kiszolgáló az alkalmazás sikeres engedélyezése után elküldi a felhasználót, és megadta az engedélyezési kódot vagy hozzáférési jogkivonatot. | Megjegyzés: Ez a paraméter nem támogatott Univerzális Windows-platform (UWP) alkalmazásokhoz. A hívónak közepes integritási szintű engedélyekkel kell rendelkeznie. Lásd: Átirányítási URI (válasz URL-cím) korlátozásai és korlátozásai |
correlationId |
Minden egyes kéréshez létrehozott egyedi GUID, amely az adatforrások közötti kérések összekapcsolására használható | Megjegyzés: Ez correlationId egy örökölt paraméter. A wam API-ban egy tulajdonság váltotta fel. Lásd: WebTokenRequest.CorrelationId tulajdonság (Windows.Security.Authentication.Web.Core) – Windows UWP-alkalmazások |
validateAuthority |
Logikai; vagy TRUE FALSE . |
A Microsoft Entra ID beépülő modul alapértelmezés szerint elvégzi a hitelesítést. Ha egy alkalmazásnak le kell tiltania ezt az ellenőrzést, akkor a következő értéket kell elküldenie FALSE validateAuthority : . Ez helyszíni forgatókönyvekben lehet hasznos. Lásd: MsalAuthenticationOptions.ValidateAuthority tulajdonság |
certificateUsage |
vpn |
Ez a paraméter tanúsítvány-jogkivonat-típus igénylésére szolgál. Az egyetlen engedélyezett érték az vpn . Ez jelenleg csak VPN-forgatókönyvekre vonatkozik. |
certificateUIName |
Bármely sztring, amely a VPN-tanúsítvány tanúsítványkijelölési felhasználói felületén jelenik meg. | A certificateUIName paraméter megadja a VPN-tanúsítvány kiválasztásakor a tanúsítványkijelölés felhasználói felületén megjelenő sztringet. |
certificateUIDescription |
Bármely sztring, amely a VPN-tanúsítvány tanúsítványkijelölési felhasználói felületén jelenik meg. | A certificateUIDescription paraméter a VPN-tanúsítvány kiválasztásakor leírásként adja meg a tanúsítványkijelölés felhasználói felületén megjelenő sztringet. |
UserPictureEnabled |
Vagy True vagy False . |
Azt jelzi, hogy az alkalmazás a jogkivonat-válasz részeként meg szeretné-e kapni a felhasználó képét. |
Username |
Felhasználónév | A Microsoft Entra-azonosító felhasználónevet jelöli |
Password |
Jelszó | A Microsoft Entra ID-felhasználó jelszavát jelöli |
SamlAssertion |
SAML-jogkivonat | KÜLSŐ identitásszolgáltatótól a Microsoft Entra ID-nak küldött, hitelesítési összetevőként küldött SAML-jogkivonat |
SamlAssertionType |
Vagy vagy "urn:ietf:params:oauth:grant-type:saml1_1-bearer" "urn:ietf:params:oauth:grant-type:saml2-bearer" |
Megadja a hitelesítéshez használt SAML-jogkivonat típusát. |
LoginHint |
Felhasználónév-tipp (upn) | A bejelentkezési folyamat során megjelenít egy tippet a felhasználónévhez. |
msafed |
Vagy 0 vagy 1 . |
Meghatározza, hogy engedélyezi-e, hogy a Microsoft-fiókkal rendelkező felhasználók összevont identitásként jelentkezzenek be egy Entra-bérlőn belül. Egy érték engedélyezi az 1 összevonást, miközben 0 letiltja azt. |
discover |
Home |
A discover paraméter azt jelzi, hogy a jogkivonat-kérés végrehajtása a felhasználó otthoni felhőjében történik, nem pedig az a felhő, amelyhez az eszköz csatlakozik. |
domain_hint |
A megfelelő tartomány. Például: contoso.com |
A Microsoft Entra ID a tipp segítségével keresi meg a tartományt a címtárban Megjegyzés: A tartományi tipp prioritást élvez a tartalék tartománysal szemben abban az esetben, ha az ADAL mindkettőt paraméterként adja át |
fallback_domain |
Tartomány, például contoso.com |
A fallback_domain paraméter egy tipp, amelyet a Microsoft Entra ID használ a tartomány könyvtárban való megkereséséhez. Elsősorban olyan nem átirányítható felhasználói tartományokhoz használják, amelyek a felhasználó UPN-jének részét képezik. |
client_TokenType |
DeviceAuth |
A client_TokenType paraméter kizárólag csak eszközalapú jogkivonatok lekérésére használható. A hívónak közepes szintű integritási szintű engedélyekkel kell rendelkeznie. |
IsFeatureSupported |
CrossCloudB2B , redirect_uri , TokenBinding . |
Annak ellenőrzésére szolgál, hogy egy funkció támogatott-e az aktuális folyamatban. |
prompt |
Vagy vagy no_select select_account |
A parancssori paraméter szabályozza a parancssori ablak viselkedését. no_select azt jelenti, hogy a rendszer nem fűzi hozzá a parancssori viselkedés vezérlőt a parancssori ablakhoz. select_account megjeleníti a fiókválasztót. A rendszer átadja a paramétert a bejelentkezési szolgáltatásnak a fiókválasztási viselkedés szabályozásához. |
minimum_token_lifetime |
Idő ezredmásodpercben. | Ez az az idő, amely előtt új jogkivonatot kell igényelni, és el kell vetni a gyorsítótár-jogkivonatot |
telemetry |
MATS |
Telemetria visszaadása a kérelemről |
enclave |
sw szoftverkulcsokat jelez, hw hardverkulcsokat jelez, kg a keyguard billentyűket jelzi. |
A enclave paraméter megadja a használni kívánt kulcsok típusát. |
token_type |
pop a birtoklási jogkivonatok igazolását jelzi shr aláírt HTTP-kérés jogkivonatait jelzi |
A token_type paraméter megadja a használandó jogkivonatok típusát. |
req_cnf |
A req_cnf paramétert akkor használja a rendszer, ha az token_type .pop Ez a mező információkat tartalmaz arról a kulcsról, amelyet az ügyfél a birtoklás igazolása céljából a hozzáférési jogkivonathoz szeretne kötni. |
|
refresh_binding |
A refresh_binding paraméter egy hamarosan megjelenő jogkivonat-kötési funkció része, amelyet még ki kell adni. |