PublicClientApplication class
Deze klasse moet worden gebruikt voor het verkrijgen van tokens voor openbare clienttoepassingen (desktop, mobiel). Openbare clienttoepassingen worden niet vertrouwd om toepassingsgeheimen veilig op te slaan en kunnen daarom alleen tokens aanvragen in de naam van een gebruiker.
- Uitbreiding
Constructors
| Public |
Belangrijke kenmerken in het configuratieobject voor verificatie zijn:
AAD-autoriteiten zijn van de vorm
Azure B2C-autoriteiten zijn van het formulier https://{instance}/{tenant}/{policy}. Elk beleid wordt beschouwd als een eigen autoriteit. U moet alle bekende verificaties instellen op het moment van de bouw van de clienttoepassing. ADFS-autoriteiten zijn van het formulier https://{instance}/adfs. |
Methoden
| acquire |
Hiermee verkrijgt u een token van de instantie met behulp van de OAuth2.0-apparaatcodestroom. Deze stroom is ontworpen voor apparaten die geen toegang hebben tot een browser of invoerbeperkingen hebben. De autorisatieserver geeft een DeviceCode-object uit met een verificatiecode, een eindgebruikercode en de verificatie-URI van de eindgebruiker. Het DeviceCode-object wordt geleverd via een callback en de eindgebruiker moet worden geïnstrueerd om een ander apparaat te gebruiken om naar de verificatie-URI te navigeren om referenties in te voeren. Omdat de client geen binnenkomende aanvragen kan ontvangen, wordt de autorisatieserver herhaaldelijk gepeild totdat de eindgebruiker de invoer van referenties heeft voltooid. |
| acquire |
Hiermee verkrijgt u een token interactief via de browser door een autorisatiecode aan te vragen en deze vervolgens uit te wisselen voor een token. |
| acquire |
Retourneert een token dat is opgehaald uit de cache of door het vernieuwingstoken uit te wisselen voor een nieuw toegangstoken. Als brokering is ingeschakeld, wordt de tokenaanvraag verwerkt door de broker. |
| get |
Retourneert alle accounts in de cache voor deze toepassing. Als brokering is ingeschakeld, wordt deze aanvraag verwerkt door de broker. |
| sign |
Verwijdert cacheartefacten die zijn gekoppeld aan het opgegeven account |
Overgenomen methoden
| acquire |
Hiermee verkrijgt u een token door de autorisatiecode uit te wisselen die is ontvangen uit de eerste stap van de OAuth2.0-autorisatiecodestroom.
|
| acquire |
Hiermee verkrijgt u een token door het vernieuwingstoken uit te wisselen dat is opgegeven voor een nieuwe set tokens. Deze API is alleen beschikbaar voor scenario's waarin u wilt migreren van ADAL naar MSAL. Anders wordt het aanbevolen om te gebruiken |
| acquire |
Hiermee verkrijgt u tokens met wachtwoordtoekenning door de gebruikersnaam en het wachtwoord van clienttoepassingen uit te wisselen voor referenties De meest recente best practice voor OAuth 2.0-beveiliging staat niet toe dat het wachtwoord volledig wordt verleend. Meer informatie over deze aanbeveling vindt u in https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 de documentatie en aanbevelingen van Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword |
| clear |
Cache legen |
| get |
Hiermee maakt u de URL van de autorisatieaanvraag, zodat de gebruikersreferenties kunnen invoeren en toestemming kunnen geven voor de toepassing. De URL is gericht op het eindpunt /authorize van de instantie die is geconfigureerd in het toepassingsobject. Zodra de gebruiker zijn referenties en toestemmingen invoert, stuurt de autoriteit een antwoord naar de omleidings-URI die in de aanvraag is verzonden en moet deze een autorisatiecode bevatten, die vervolgens kan worden gebruikt om tokens te verkrijgen via |
| get |
Retourneert het loggerexemplaren |
| get |
Hiermee haalt u de tokencache voor de toepassing op. |
| set |
Vervangt de standaardlogger die is ingesteld in configuraties door nieuwe logger door nieuwe configuraties |
Constructordetails
PublicClientApplication(Configuration)
Belangrijke kenmerken in het configuratieobject voor verificatie zijn:
- clientID: de toepassings-id van uw toepassing. U kunt er een verkrijgen door uw toepassing te registreren bij onze portal voor toepassingsregistratie.
- instantie: de URL van de instantie voor uw toepassing.
AAD-autoriteiten zijn van de vorm https://login.microsoftonline.com/{Enter_the_Tenant_Info_Here}.
- Als uw toepassing accounts in één organisatiemap ondersteunt, vervangt u de waarde 'Enter_the_Tenant_Info_Here' door de tenant-id of tenantnaam (bijvoorbeeld contoso.microsoft.com).
- Als uw toepassing accounts in een organisatiemap ondersteunt, vervangt u de waarde 'Enter_the_Tenant_Info_Here' door organisaties.
- Als uw toepassing accounts in een organisatiedirectory en persoonlijke Microsoft accounts ondersteunt, vervangt u de waarde 'Enter_the_Tenant_Info_Here' door algemene waarden.
- Als u alleen ondersteuning wilt beperken tot persoonlijke Microsoft-accounts, vervangt u de waarde 'Enter_the_Tenant_Info_Here' door consumenten.
Azure B2C-autoriteiten zijn van het formulier https://{instance}/{tenant}/{policy}. Elk beleid wordt beschouwd als een eigen autoriteit. U moet alle bekende verificaties instellen op het moment van de bouw van de clienttoepassing.
ADFS-autoriteiten zijn van het formulier https://{instance}/adfs.
new PublicClientApplication(configuration: Configuration)
Parameters
- configuration
- Configuration
Methodedetails
acquireTokenByDeviceCode(DeviceCodeRequest)
Hiermee verkrijgt u een token van de instantie met behulp van de OAuth2.0-apparaatcodestroom. Deze stroom is ontworpen voor apparaten die geen toegang hebben tot een browser of invoerbeperkingen hebben. De autorisatieserver geeft een DeviceCode-object uit met een verificatiecode, een eindgebruikercode en de verificatie-URI van de eindgebruiker. Het DeviceCode-object wordt geleverd via een callback en de eindgebruiker moet worden geïnstrueerd om een ander apparaat te gebruiken om naar de verificatie-URI te navigeren om referenties in te voeren. Omdat de client geen binnenkomende aanvragen kan ontvangen, wordt de autorisatieserver herhaaldelijk gepeild totdat de eindgebruiker de invoer van referenties heeft voltooid.
function acquireTokenByDeviceCode(request: DeviceCodeRequest): Promise<null | AuthenticationResult>
Parameters
- request
- DeviceCodeRequest
Retouren
Promise<null | AuthenticationResult>
acquireTokenInteractive(InteractiveRequest)
Hiermee verkrijgt u een token interactief via de browser door een autorisatiecode aan te vragen en deze vervolgens uit te wisselen voor een token.
function acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult>
Parameters
- request
- InteractiveRequest
Retouren
Promise<AuthenticationResult>
acquireTokenSilent(SilentFlowRequest)
Retourneert een token dat is opgehaald uit de cache of door het vernieuwingstoken uit te wisselen voor een nieuw toegangstoken. Als brokering is ingeschakeld, wordt de tokenaanvraag verwerkt door de broker.
function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>
Parameters
- request
- SilentFlowRequest
ontwikkelaar heeft SilentFlowRequest geleverd
Retouren
Promise<AuthenticationResult>
getAllAccounts()
Retourneert alle accounts in de cache voor deze toepassing. Als brokering is ingeschakeld, wordt deze aanvraag verwerkt door de broker.
function getAllAccounts(): Promise<AccountInfo[]>
Retouren
Promise<AccountInfo[]>
signOut(SignOutRequest)
Verwijdert cacheartefacten die zijn gekoppeld aan het opgegeven account
function signOut(request: SignOutRequest): Promise<void>
Parameters
- request
- SignOutRequest
ontwikkelaar heeft SignOutRequest geleverd
Retouren
Promise<void>
Details overgenomen methode
acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)
Hiermee verkrijgt u een token door de autorisatiecode uit te wisselen die is ontvangen uit de eerste stap van de OAuth2.0-autorisatiecodestroom.
getAuthCodeUrl(AuthorizationCodeUrlRequest) kan worden gebruikt om de URL te maken voor de eerste stap van de OAuth2.0-autorisatiecodestroom. Zorg ervoor dat waarden voor redirectUri en scopes in AuthorizationCodeUrlRequest en AuthorizationCodeRequest hetzelfde zijn.
function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>
Parameters
- request
- AuthorizationCodeRequest
- authCodePayLoad
- AuthorizationCodePayload
Retouren
Promise<AuthenticationResult>
Overgenomen vanClientApplication.acquireTokenByCode
acquireTokenByRefreshToken(RefreshTokenRequest)
Hiermee verkrijgt u een token door het vernieuwingstoken uit te wisselen dat is opgegeven voor een nieuwe set tokens.
Deze API is alleen beschikbaar voor scenario's waarin u wilt migreren van ADAL naar MSAL. Anders wordt het aanbevolen om te gebruiken acquireTokenSilent() voor stille scenario's. Wanneer u msal gebruikt acquireTokenSilent(), wordt de cache en het vernieuwen van tokens automatisch verwerkt.
function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>
Parameters
- request
- RefreshTokenRequest
Retouren
Promise<null | AuthenticationResult>
Overgenomen vanClientApplication.acquireTokenByRefreshToken
acquireTokenByUsernamePassword(UsernamePasswordRequest)
Waarschuwing
Deze API is nu afgeschaft.
- Use a more secure flow instead
Hiermee verkrijgt u tokens met wachtwoordtoekenning door de gebruikersnaam en het wachtwoord van clienttoepassingen uit te wisselen voor referenties
De meest recente best practice voor OAuth 2.0-beveiliging staat niet toe dat het wachtwoord volledig wordt verleend. Meer informatie over deze aanbeveling vindt u in https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 de documentatie en aanbevelingen van Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>
Parameters
- request
- UsernamePasswordRequest
UsenamePasswordRequest
Retouren
Promise<null | AuthenticationResult>
Overgenomen vanClientApplication.acquireTokenByUsernamePassword
clearCache()
getAuthCodeUrl(AuthorizationUrlRequest)
Hiermee maakt u de URL van de autorisatieaanvraag, zodat de gebruikersreferenties kunnen invoeren en toestemming kunnen geven voor de toepassing. De URL is gericht op het eindpunt /authorize van de instantie die is geconfigureerd in het toepassingsobject.
Zodra de gebruiker zijn referenties en toestemmingen invoert, stuurt de autoriteit een antwoord naar de omleidings-URI die in de aanvraag is verzonden en moet deze een autorisatiecode bevatten, die vervolgens kan worden gebruikt om tokens te verkrijgen via acquireTokenByCode(AuthorizationCodeRequest).
function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>
Parameters
- request
- AuthorizationUrlRequest
Retouren
Promise<string>
Overgenomen vanClientApplication.getAuthCodeUrl
getLogger()
Retourneert het loggerexemplaren
function getLogger(): Logger
Retouren
Overgenomen vanClientApplication.getLogger
getTokenCache()
Hiermee haalt u de tokencache voor de toepassing op.
function getTokenCache(): TokenCache
Retouren
Overgenomen vanClientApplication.getTokenCache
setLogger(Logger)
Vervangt de standaardlogger die is ingesteld in configuraties door nieuwe logger door nieuwe configuraties
function setLogger(logger: Logger)
Parameters
- logger
- Logger
Loggerexemplaren
Overgenomen vanClientApplication.setLogger