IAuthenticationOperation2 Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This is an extensibility API and should only be used by SDKs. Enhanced version of IAuthenticationOperation that supports asynchronous token formatting. Used to modify the experience depending on the type of token asked with async capabilities.
public interface IAuthenticationOperation2 : Microsoft.Identity.Client.AuthScheme.IAuthenticationOperationtype IAuthenticationOperation2 = interface
interface IAuthenticationOperationPublic Interface IAuthenticationOperation2
Implements IAuthenticationOperation- Implements
Properties
| Name | Description |
|---|---|
| AccessTokenType |
Expected to match the token_type parameter returned by ESTS. Used to disambiguate between ATs of different types (e.g. Bearer and PoP) when loading from cache etc. (Inherited from IAuthenticationOperation) |
| AuthorizationHeaderPrefix |
Prefix for the HTTP header that has the token. E.g. "Bearer" or "POP" (Inherited from IAuthenticationOperation) |
| KeyId |
Key ID of the public / private key pair used by the encryption algorithm, if any. Tokens obtained by authentication schemes that use this are bound to the KeyId, i.e. if a different kid is presented, the access token cannot be used. (Inherited from IAuthenticationOperation) |
| TelemetryTokenType |
Value to log to telemetry Values available: Bearer token type. Bearer = 1 Pop token type. Pop = 2, Ssh-cert token type. SshCert = 3, External token type. External = 4, Extension token type. Extension = 5 (Inherited from IAuthenticationOperation) |
Methods
| Name | Description |
|---|---|
| FormatResult(AuthenticationResult) |
Creates the access token that goes into an Authorization HTTP header. (Inherited from IAuthenticationOperation) |
| FormatResultAsync(AuthenticationResult, CancellationToken) |
Will be invoked instead of IAuthenticationOperation.FormatResult |
| GetTokenRequestParams() |
Extra parameters that are added to the request to the /token endpoint. (Inherited from IAuthenticationOperation) |
| ValidateCachedTokenAsync(MsalCacheValidationData) |
Determines whether the cached token is still valid. |