ConfidentialClientApplication Klas
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Klasse die moet worden gebruikt voor vertrouwelijke clienttoepassingen (web-apps, web-API's en daemon-toepassingen).
public sealed class ConfidentialClientApplication : Microsoft.Identity.Client.ClientApplicationBase, Microsoft.Identity.Client.IByRefreshToken, Microsoft.Identity.Client.IByUsernameAndPassword, Microsoft.Identity.Client.IConfidentialClientApplication, Microsoft.Identity.Client.ILongRunningWebApi
type ConfidentialClientApplication = class
inherit ClientApplicationBase
interface IConfidentialClientApplication
interface IClientApplicationBase
interface IApplicationBase
interface IByUserFederatedIdentityCredential
interface IByRefreshToken
interface ILongRunningWebApi
interface IByUsernameAndPassword
Public NotInheritable Class ConfidentialClientApplication
Inherits ClientApplicationBase
Implements IByRefreshToken, IByUsernameAndPassword, IConfidentialClientApplication, ILongRunningWebApi
- Overname
- Implementeringen
Opmerkingen
Vertrouwelijke clienttoepassingen zijn doorgaans toepassingen die worden uitgevoerd op servers (web-apps, web-API of zelfs service-/daemon-toepassingen). Ze worden beschouwd als moeilijk toegankelijk en kunnen daarom een toepassingsgeheim bewaren (bewaar configuratietijdgeheimen omdat deze waarden moeilijk zijn voor eindgebruikers om te extraheren). Een web-app is de meest voorkomende vertrouwelijke client. De clientId wordt weergegeven via de webbrowser, maar het geheim wordt alleen doorgegeven in het back-kanaal en wordt nooit rechtstreeks weergegeven. Zie voor meer informatie https://aka.ms/msal-net-client-applications
Velden
| Name | Description |
|---|---|
| AttemptRegionDiscovery |
Hiermee wordt MSAL geïnstrueerd om de Azure regio automatisch te detecteren. |
Eigenschappen
| Name | Description |
|---|---|
| AppConfig |
Details over de configuratie van de ClientApplication voor foutopsporingsdoeleinden. (Overgenomen van ClientApplicationBase) |
| AppTokenCache |
Toepassingstokencache. In dit geval worden toegangstokens voor de toepassing opgeslagen. Het wordt onderhouden en op de achtergrond bijgewerkt indien nodig bij het bellen AcquireTokenForClient(IEnumerable<String>) |
| Authority |
Hiermee haalt u de URL van de instantie of de beveiligingstokenservice (STS) op van waaruit MSAL.NET beveiligingstokens krijgt. De retourwaarde van deze eigenschap is de waarde die door de ontwikkelaar wordt verstrekt in de constructor van de toepassing, of anderszins de waarde van het Microsoft.Identity.Client.ApplicationBase.DefaultAuthority statische lid (dat wil |
| Certificate |
Het certificaat dat wordt gebruikt om dit ConfidentialClientApplicationte maken, indien van toepassing. |
| UserTokenCache |
Cache van gebruikerstoken. Het bevat toegangstokens, id-tokens en vernieuwingstokens voor accounts. Deze wordt indien nodig op de achtergrond gebruikt en bijgewerkt wanneer u belt AcquireTokenSilent(IEnumerable<String>, IAccount) of een van de onderdrukkingen van AcquireTokenSilent(IEnumerable<String>, IAccount).
Het wordt bijgewerkt door elke AcquireTokenXXX-methode, met uitzondering waarvan |
Methoden
| Name | Description |
|---|---|
| AcquireTokenByAuthorizationCode(IEnumerable<String>, String) |
Hiermee verkrijgt u een beveiligingstoken van de instantie die in de app is geconfigureerd met behulp van de autorisatiecode die eerder is ontvangen van de STS. Het maakt gebruik van de OAuth 2.0-autorisatiecodestroom (zie https://aka.ms/msal-net-authorization-code). Deze wordt meestal gebruikt in web-apps (bijvoorbeeld ASP.NET/ASP.NET Core web-apps) die gebruikers aanmelden en een autorisatiecode kunnen aanvragen. Met deze methode wordt de tokencache niet opgezoekd, maar wordt het resultaat erin opgeslagen, zodat het kan worden opgezoekd met behulp van andere methoden, zoals AcquireTokenSilent(IEnumerable<String>, IAccount). |
| AcquireTokenForClient(IEnumerable<String>) |
Hiermee verkrijgt u een token van de instantie die in de app is geconfigureerd, voor de vertrouwelijke client zelf (in de naam van geen gebruiker) met behulp van de clientreferentiestroom. Zie https://aka.ms/msal-net-client-credentials. |
| AcquireTokenInLongRunningProcess(IEnumerable<String>, String) |
Haalt een toegangstoken op uit de cache met behulp van de opgegeven cachesleutel die kan worden gebruikt voor toegang tot een andere downstream beveiligde web-API namens een gebruiker met behulp van de OAuth 2.0 On-Behalf-Of-stroom. Zie Langlopende OBO in MSAL.NET. Gebruik <seealso cref="M:Microsoft. Identity.Client.Extensibility.ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync(Microsoft. Identity.Client.ILongRunningWebApi,System.String,System.Threading.CancellationToken)"></seealso> om het langdurige proces te stoppen en de bijbehorende tokens uit de cache te verwijderen. |
| AcquireTokenOnBehalfOf(IEnumerable<String>, UserAssertion) |
Hiermee verkrijgt u een toegangstoken voor deze toepassing (meestal een web-API) van de instantie die is geconfigureerd in de toepassing, om namens een gebruiker toegang te krijgen tot een andere downstream beveiligde web-API met behulp van de OAuth 2.0 On-Behalf-Of stroom.
Zie https://aka.ms/msal-net-on-behalf-of.
Deze vertrouwelijke clienttoepassing is zelf aangeroepen met een token dat wordt opgegeven in de |
| AcquireTokenSilent(IEnumerable<String>, IAccount) |
[V3 API] Hiermee probeert u een toegangstoken voor het |
| AcquireTokenSilent(IEnumerable<String>, String) |
[V3 API] Probeert een toegangstoken te verkrijgen voor het IAccount feit dat het overeenkomt met de Username opgegeven |
| GetAccountAsync(String, CancellationToken) |
Haal de IAccount id op van de accounts die beschikbaar zijn in de tokencache. (Overgenomen van ClientApplicationBase) |
| GetAccountAsync(String) |
Haal de IAccount id op van de accounts die beschikbaar zijn in de tokencache. (Overgenomen van ClientApplicationBase) |
| GetAccountsAsync() |
Retourneert alle beschikbare accounts in de cache van het gebruikerstoken voor de toepassing. (Overgenomen van ClientApplicationBase) |
| GetAccountsAsync(CancellationToken) |
Retourneert alle beschikbare accounts in de cache van het gebruikerstoken voor de toepassing. (Overgenomen van ClientApplicationBase) |
| GetAccountsAsync(String, CancellationToken) |
Haal de IAccount verzameling op basis van de id op van de accounts die beschikbaar zijn in de tokencache, op basis van de gebruikersstroom. Dit is voor Azure AD B2C-scenario's. (Overgenomen van ClientApplicationBase) |
| GetAccountsAsync(String) |
Haal de IAccount verzameling op basis van de id op van de accounts die beschikbaar zijn in de tokencache, op basis van de gebruikersstroom. Dit is voor Azure AD B2C-scenario's. (Overgenomen van ClientApplicationBase) |
| GetAuthorizationRequestUrl(IEnumerable<String>) |
Berekent de URL van de autorisatieaanvraag zodat de gebruiker zich kan aanmelden en toestemming geeft voor de toepassing die toegang heeft tot specifieke bereiken in de naam van de gebruiker. De URL is gericht op het eindpunt /authorize van de instantie die in de toepassing is geconfigureerd. Met deze onderdrukking kunt u een aanmeldingshint en extra queryparameter opgeven. |
| InitiateLongRunningProcessInWebApi(IEnumerable<String>, String, String) |
Hiermee verkrijgt u een toegangstoken voor deze web-API van de instantie die is geconfigureerd in de toepassing, om namens een gebruiker toegang te krijgen tot een andere downstream beveiligde web-API met behulp van de OAuth 2.0 On-Behalf-Of stroom.
Zie Langlopende OBO in MSAL.NET.
Geef een toegangstoken (geen id-token) door dat is gebruikt om deze vertrouwelijke clienttoepassing aan te roepen in de |
| RemoveAsync(IAccount, CancellationToken) |
Hiermee verwijdert u alle tokens in de cache voor het opgegeven account. (Overgenomen van ClientApplicationBase) |
| RemoveAsync(IAccount) |
Hiermee verwijdert u alle tokens in de cache voor het opgegeven account. (Overgenomen van ClientApplicationBase) |
| StopLongRunningProcessInWebApiAsync(String, CancellationToken) |
Hiermee stopt u een langlopende sessie namens de sessie door de tokens te verwijderen die zijn gekoppeld aan de opgegeven cachesleutel. Zie Langlopende OBO in MSAL.NET. |
Expliciete interface-implementaties
| Name | Description |
|---|---|
| IByRefreshToken.AcquireTokenByRefreshToken(IEnumerable<String>, String) |
Klasse die moet worden gebruikt voor vertrouwelijke clienttoepassingen (web-apps, web-API's en daemon-toepassingen). |
| IByUserFederatedIdentityCredential.AcquireTokenByUserFederatedIdentityCredential(IEnumerable<String>, Guid, String) |
Verwerft een token namens een gebruiker met behulp van een federatieve identiteitsreferentie-assertie.
Hierbij wordt het |
| IByUserFederatedIdentityCredential.AcquireTokenByUserFederatedIdentityCredential(IEnumerable<String>, String, String) |
Verwerft een token namens een gebruiker met behulp van een federatieve identiteitsreferentie-assertie.
Hierbij wordt het |
| IByUsernameAndPassword.AcquireTokenByUsernamePassword(IEnumerable<String>, String, String) |
Verwerft een token zonder tussenkomst van de gebruiker met behulp van gebruikersnaam- en wachtwoordverificatie. Deze methode kijkt niet in de tokencache, maar slaat het resultaat erin op. Voordat u deze methode aanroept, gebruikt u andere methoden, zoals AcquireTokenSilent(IEnumerable<String>, IAccount) het controleren van de tokencache. |
Extensiemethoden
| Name | Description |
|---|---|
| GetCertificate(IConfidentialClientApplication) |
Retourneert het certificaat dat is gebruikt om dit ConfidentialClientApplicationte maken, indien van toepassing. |
| StopLongRunningProcessInWebApiAsync(ILongRunningWebApi, String, CancellationToken) |
Hiermee stopt u een langlopende sessie namens de sessie door de tokens te verwijderen die zijn gekoppeld aan de opgegeven cachesleutel. Zie Langlopende OBO in MSAL.NET. |