ConfidentialClientApplication class

Csomag:

@azure/msal-node

Ez az osztály a bizalmas ügyfélalkalmazások (webApp, webAPI) jogkivonatainak beszerzésére szolgál. A bizalmas ügyfélalkalmazások szükség szerint konfigurálják az alkalmazás titkos kulcsait, az ügyféltanúsítványokat és -állításokat

Extends

ClientApplication

Konstruktorok

ConfidentialClientApplication(Configuration)

A ConfidentialClientApplication konstruktora A konfigurációs objektum szükséges attribútumai a következők: clientID: az alkalmazás alkalmazásazonosítója. Az alkalmazást az alkalmazásregisztrációs portálon regisztrálva szerezheti be. szolgáltató: az alkalmazás szolgáltatói URL-címe. ügyfél hitelesítő adatai: Meg kell adnia az ügyfél titkos kulcsát, tanúsítványát vagy állítását a bizalmas ügyfelek számára. Az ügyfél titkos kódját az alkalmazásregisztrációs portálon szerezheti be. A Azure AD-ben a szolgáltató az űrlapot https://login.microsoftonline.com/{Enter_the_Tenant_Info_Here}jelző URL-cím. Ha az alkalmazás támogatja a fiókokat egy szervezeti címtárban, cserélje le a "Enter_the_Tenant_Info_Here" értéket a bérlőazonosítóra vagy a bérlő nevére (például contoso.microsoft.com). Ha az alkalmazás bármely szervezeti címtárban támogatja a fiókokat, cserélje le a "Enter_the_Tenant_Info_Here" értéket a szervezetekre. Ha az alkalmazás bármely szervezeti címtárban és személyes Microsoft fiókban támogatja a fiókokat, cserélje le a "Enter_the_Tenant_Info_Here" értéket a közös értékre. Ha csak a személyes Microsoft fiókok támogatását szeretné korlátozni, cserélje le a "Enter_the_Tenant_Info_Here" értéket a fogyasztókra. Az Azure B2C-ben a szolgáltató https://{instance}/tfp/{tenant}/{policyName}/ A teljes B2C-funkció elérhető lesz ebben a kódtárban a későbbi verziókban.

Metódusok

acquireTokenByClientCredential(ClientCredentialRequest)	Jogkivonatokat szerez be az alkalmazás szolgáltatójától (nem végfelhasználók számára).
acquireTokenOnBehalfOf(OnBehalfOfRequest)	Jogkivonatokat szerez be az alkalmazás szolgáltatójától. Olyan helyzetekben használatos, ahol az aktuális alkalmazás egy középszintű szolgáltatás, amelyet egy végfelhasználót jelképező jogkivonattal hívtak meg. Az aktuális alkalmazás a jogkivonat (oboAssertion) használatával kérhet egy másik jogkivonatot a downstream webes API eléréséhez a felhasználó nevében. A jelenlegi középső szintű alkalmazás nem rendelkezik felhasználói beavatkozással a hozzájárulás beszerzéséhez. Ebből a cikkből megtudhatja, hogyan szerezhet előzetes hozzájárulást a középső szintű alkalmazáshoz. https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow#gaining-consent-for-the-middle-tier-application
SetAppTokenProvider(IAppTokenProvider)	Ez a bővíthetőségi pont csak a client_credential folyamathoz, azaz a acquireTokenByClientCredentialhoz működik, és Azure SDK a felügyelt identitások támogatásának javítására szolgál.

Örökölt metódusok

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)	Jogkivonatot szerez be az OAuth2.0 engedélyezési kód folyamatának első lépésétől kapott engedélyezési kód cseréjével. getAuthCodeUrl(AuthorizationCodeUrlRequest) az OAuth2.0 engedélyezési kód folyamatának első lépéséhez használható az URL-cím létrehozásához. Győződjön meg arról, hogy az AuthorizationCodeUrlRequest és az AuthorizationCodeRequest átirányításiuri és hatóköreinek értékei megegyeznek.
acquireTokenByRefreshToken(RefreshTokenRequest)	A jogkivonatot az új jogkivonatok frissítési jogkivonatának cseréjével szerzi be. Ez az API csak olyan forgatókönyvekhez érhető el, ahol ADAL-ról MSAL-ra szeretne migrálni. Ellenkező esetben ajánlott csendes forgatókönyvekhez használni acquireTokenSilent() . A használat során acquireTokenSilent()az MSAL automatikusan kezeli a jogkivonatok gyorsítótárazását és frissítését.
acquireTokenByUsernamePassword(UsernamePasswordRequest)	Jogkivonatokat szerez be jelszó megadásával az ügyfélalkalmazások felhasználónév és jelszó cseréjével a hitelesítő adatokhoz A legújabb OAuth 2.0 biztonsági ajánlott eljárás teljes mértékben letiltja a jelszó megadását. A javaslatról https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 további információt Microsoft dokumentációjában és javaslatában talál:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
acquireTokenSilent(SilentFlowRequest)	Csendesen beolvas egy jogkivonatot, amikor egy felhasználó megadja azt a fiókot, amelyhez a jogkivonatot kérik. Ez az API elvárja a felhasználótól, hogy adjon meg egy fiókobjektumot, és vizsgálja meg a gyorsítótárat, hogy lekérje a jogkivonatot, ha van ilyen. Van egy opcionális "forceRefresh" logikai is, amelyet a felhasználó küldhet, hogy megkerülje access_token és id_token gyorsítótárát. Abban az esetben, ha a refresh_token lejárt vagy nem található, hibaüzenet jelenik meg, és az útmutató az, hogy a felhasználó meghívjon bármilyen interaktív jogkivonat-beszerzési API-t (például: acquireTokenByCode()).
clearCache()	A gyorsítótár törlése
getAuthCodeUrl(AuthorizationUrlRequest)	Létrehozza az engedélyezési kérelem URL-címét, lehetővé téve a felhasználó számára a hitelesítő adatok megadását és az alkalmazáshoz való hozzájárulást. Az URL az alkalmazásobjektumban konfigurált szolgáltató /engedélyezési végpontját célozza meg. Miután a felhasználó megadta a hitelesítő adatait és beleegyezéseit, a szolgáltató választ küld a kérelemben küldött átirányítási URI-nak, és tartalmaznia kell egy engedélyezési kódot, amely ezután a jogkivonatok acquireTokenByCode(AuthorizationCodeRequest)beszerzésére használható.
getLogger()	A naplózópéldányt adja vissza
getTokenCache()	Lekéri az alkalmazás jogkivonat-gyorsítótárát.
setLogger(Logger)	A konfigurációkban beállított alapértelmezett naplózó lecserélése új naplózóra új konfigurációkra

Konstruktor adatai

ConfidentialClientApplication(Configuration)

A ConfidentialClientApplication konstruktora

A konfigurációs objektum szükséges attribútumai a következők:

• clientID: az alkalmazás alkalmazásazonosítója. Az alkalmazást az alkalmazásregisztrációs portálon regisztrálva szerezheti be.
• szolgáltató: az alkalmazás szolgáltatói URL-címe.
• ügyfél hitelesítő adatai: Meg kell adnia az ügyfél titkos kulcsát, tanúsítványát vagy állítását a bizalmas ügyfelek számára. Az ügyfél titkos kódját az alkalmazásregisztrációs portálon szerezheti be.

A Azure AD-ben a szolgáltató az űrlapot https://login.microsoftonline.com/{Enter_the_Tenant_Info_Here}jelző URL-cím. Ha az alkalmazás támogatja a fiókokat egy szervezeti címtárban, cserélje le a "Enter_the_Tenant_Info_Here" értéket a bérlőazonosítóra vagy a bérlő nevére (például contoso.microsoft.com). Ha az alkalmazás bármely szervezeti címtárban támogatja a fiókokat, cserélje le a "Enter_the_Tenant_Info_Here" értéket a szervezetekre. Ha az alkalmazás bármely szervezeti címtárban és személyes Microsoft fiókban támogatja a fiókokat, cserélje le a "Enter_the_Tenant_Info_Here" értéket a közös értékre. Ha csak a személyes Microsoft fiókok támogatását szeretné korlátozni, cserélje le a "Enter_the_Tenant_Info_Here" értéket a fogyasztókra.

Az Azure B2C-ben a szolgáltató https://{instance}/tfp/{tenant}/{policyName}/ A teljes B2C-funkció elérhető lesz ebben a kódtárban a későbbi verziókban.

new ConfidentialClientApplication(configuration: Configuration)

Paraméterek

configuration

Configuration

Metódus adatai

acquireTokenByClientCredential(ClientCredentialRequest)

Jogkivonatokat szerez be az alkalmazás szolgáltatójától (nem végfelhasználók számára).

function acquireTokenByClientCredential(request: ClientCredentialRequest): Promise<null | AuthenticationResult>

Paraméterek

request

ClientCredentialRequest

Válaszok

Promise<null | AuthenticationResult>

acquireTokenOnBehalfOf(OnBehalfOfRequest)

Jogkivonatokat szerez be az alkalmazás szolgáltatójától.

Olyan helyzetekben használatos, ahol az aktuális alkalmazás egy középszintű szolgáltatás, amelyet egy végfelhasználót jelképező jogkivonattal hívtak meg. Az aktuális alkalmazás a jogkivonat (oboAssertion) használatával kérhet egy másik jogkivonatot a downstream webes API eléréséhez a felhasználó nevében.

A jelenlegi középső szintű alkalmazás nem rendelkezik felhasználói beavatkozással a hozzájárulás beszerzéséhez. Ebből a cikkből megtudhatja, hogyan szerezhet előzetes hozzájárulást a középső szintű alkalmazáshoz. https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow#gaining-consent-for-the-middle-tier-application

function acquireTokenOnBehalfOf(request: OnBehalfOfRequest): Promise<null | AuthenticationResult>

Paraméterek

request

OnBehalfOfRequest

Válaszok

Promise<null | AuthenticationResult>

SetAppTokenProvider(IAppTokenProvider)

Ez a bővíthetőségi pont csak a client_credential folyamathoz, azaz a acquireTokenByClientCredentialhoz működik, és Azure SDK a felügyelt identitások támogatásának javítására szolgál.

function SetAppTokenProvider(provider: IAppTokenProvider)

Paraméterek

provider

IAppTokenProvider

Örökölt metódus részletei

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Jogkivonatot szerez be az OAuth2.0 engedélyezési kód folyamatának első lépésétől kapott engedélyezési kód cseréjével.

getAuthCodeUrl(AuthorizationCodeUrlRequest) az OAuth2.0 engedélyezési kód folyamatának első lépéséhez használható az URL-cím létrehozásához. Győződjön meg arról, hogy az AuthorizationCodeUrlRequest és az AuthorizationCodeRequest átirányításiuri és hatóköreinek értékei megegyeznek.

function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>

Paraméterek

request

AuthorizationCodeRequest

authCodePayLoad

AuthorizationCodePayload

Válaszok

Promise<AuthenticationResult>

Örökölta ClientApplication.acquireTokenByCode-tól

acquireTokenByRefreshToken(RefreshTokenRequest)

A jogkivonatot az új jogkivonatok frissítési jogkivonatának cseréjével szerzi be.

Ez az API csak olyan forgatókönyvekhez érhető el, ahol ADAL-ról MSAL-ra szeretne migrálni. Ellenkező esetben ajánlott csendes forgatókönyvekhez használni acquireTokenSilent() . A használat során acquireTokenSilent()az MSAL automatikusan kezeli a jogkivonatok gyorsítótárazását és frissítését.

function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>

Paraméterek

request

RefreshTokenRequest

Válaszok

Promise<null | AuthenticationResult>

A ClientApplication.acquireTokenByRefreshTokenörökölte

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Figyelmeztetés

Ez az API már elavult.

• Use a more secure flow instead

Jogkivonatokat szerez be jelszó megadásával az ügyfélalkalmazások felhasználónév és jelszó cseréjével a hitelesítő adatokhoz

A legújabb OAuth 2.0 biztonsági ajánlott eljárás teljes mértékben letiltja a jelszó megadását. A javaslatról https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 további információt Microsoft dokumentációjában és javaslatában talál:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>

Paraméterek

request

UsernamePasswordRequest

UsenamePasswordRequest

Válaszok

Promise<null | AuthenticationResult>

Örökölt a ClientApplication.acquireTokenByUsernamePasswordfájlból

acquireTokenSilent(SilentFlowRequest)

Csendesen beolvas egy jogkivonatot, amikor egy felhasználó megadja azt a fiókot, amelyhez a jogkivonatot kérik.

Ez az API elvárja a felhasználótól, hogy adjon meg egy fiókobjektumot, és vizsgálja meg a gyorsítótárat, hogy lekérje a jogkivonatot, ha van ilyen. Van egy opcionális "forceRefresh" logikai is, amelyet a felhasználó küldhet, hogy megkerülje access_token és id_token gyorsítótárát. Abban az esetben, ha a refresh_token lejárt vagy nem található, hibaüzenet jelenik meg, és az útmutató az, hogy a felhasználó meghívjon bármilyen interaktív jogkivonat-beszerzési API-t (például: acquireTokenByCode()).

function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>

Paraméterek

request

SilentFlowRequest

Válaszok

Promise<AuthenticationResult>

Örökölt aClientApplication.acquireTokenSilent fájlból

clearCache()

A gyorsítótár törlése

function clearCache()

AClientApplication.clearCache-től örökölt

getAuthCodeUrl(AuthorizationUrlRequest)

Létrehozza az engedélyezési kérelem URL-címét, lehetővé téve a felhasználó számára a hitelesítő adatok megadását és az alkalmazáshoz való hozzájárulást. Az URL az alkalmazásobjektumban konfigurált szolgáltató /engedélyezési végpontját célozza meg.

Miután a felhasználó megadta a hitelesítő adatait és beleegyezéseit, a szolgáltató választ küld a kérelemben küldött átirányítási URI-nak, és tartalmaznia kell egy engedélyezési kódot, amely ezután a jogkivonatok acquireTokenByCode(AuthorizationCodeRequest)beszerzésére használható.

function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>

Paraméterek

request

AuthorizationUrlRequest

Válaszok

Promise<string>

Örökölte aClientApplication.getAuthCodeUrl

getLogger()

A naplózópéldányt adja vissza

function getLogger(): Logger

Válaszok

Logger

Örökölte aClientApplication.getLogger

getTokenCache()

Lekéri az alkalmazás jogkivonat-gyorsítótárát.

function getTokenCache(): TokenCache

Válaszok

TokenCache

Örökölte aClientApplication.getTokenCache

setLogger(Logger)

A konfigurációkban beállított alapértelmezett naplózó lecserélése új naplózóra új konfigurációkra

function setLogger(logger: Logger)

Paraméterek

logger

Logger

Naplózópéldány

AClientApplication.setLoggertől örökölt