Documentation Index Fetch the complete documentation index at: https://easyaf.dev/llms.txt
Use this file to discover all available pages before exploring further.
Definition Assembly: Microsoft.OData.Mcp.Authentication.dllNamespace: Microsoft.OData.Mcp.Authentication.ServicesInheritance: System.ObjectSyntax Microsoft . OData . Mcp . Authentication . Services . TokenValidationService
Summary Provides services for validating JWT tokens and extracting user context.
This service handles JWT token validation using Microsoft’s IdentityModel libraries,
including automatic discovery of validation keys and comprehensive claim extraction.
Constructors Initializes a new instance of the TokenValidationService class.
Syntax public TokenValidationService ( Microsoft . Extensions . Options . IOptions < Microsoft . OData . Mcp . Authentication . Models . McpAuthenticationOptions > options , Microsoft . Extensions . Logging . ILogger < Microsoft . OData . Mcp . Authentication . Services . TokenValidationService > logger )
Parameters Name Type Description optionsMicrosoft.Extensions.Options.IOptions<Microsoft.OData.Mcp.Authentication.Models.McpAuthenticationOptions>The authentication options. loggerMicrosoft.Extensions.Logging.ILogger<Microsoft.OData.Mcp.Authentication.Services.TokenValidationService>The logger instance.
Exceptions Exception Description ArgumentNullExceptionThrown when options or logger is null.
Inherited Syntax Methods Inherited Virtual Syntax public virtual bool Equals ( object obj )
Parameters Name Type Description objobject?-
Returns Type: bool
Inherited Syntax public static bool Equals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Extracts the user context from a validated claims principal.
Syntax public Microsoft . OData . Mcp . Authentication . Models . UserContext ExtractUserContext ( System . Security . Claims . ClaimsPrincipal principal )
Parameters Name Type Description principalSystem.Security.Claims.ClaimsPrincipalThe claims principal from a validated token.
Returns Type: Microsoft.OData.Mcp.Authentication.Models.UserContext
The user context containing identity and authorization information.
Gets the authorization metadata from the JWT token for downstream services.
Syntax public System . Threading . Tasks . Task < Microsoft . OData . Mcp . Authentication . Models . AuthorizationMetadata > GetAuthorizationMetadataAsync ( string token )
Parameters Name Type Description tokenstringThe JWT token to extract metadata from.
Returns Type: System.Threading.Tasks.Task<Microsoft.OData.Mcp.Authentication.Models.AuthorizationMetadata>
A task that represents the asynchronous operation. The task result contains the authorization metadata.
Inherited Virtual Syntax public virtual int GetHashCode ()
Returns Type: int
Gets the remaining lifetime of a token.
Syntax public System . Nullable < System . TimeSpan > GetTokenLifetime ( System . Security . Claims . ClaimsPrincipal principal )
Parameters Name Type Description principalSystem.Security.Claims.ClaimsPrincipalThe claims principal from a validated token.
Returns Type: System.Nullable<System.TimeSpan>
The remaining time before the token expires, or null if the token has no expiration.
Inherited Syntax public System . Type GetType ()
Returns Type: System.Type
Checks if a user has the required scopes for a specific operation.
Syntax public bool HasRequiredScopes ( Microsoft . OData . Mcp . Authentication . Models . UserContext userContext , System . Collections . Generic . IEnumerable < string > requiredScopes )
Parameters Name Type Description userContextMicrosoft.OData.Mcp.Authentication.Models.UserContextThe user context to check. requiredScopesSystem.Collections.Generic.IEnumerable<string>The scopes required for the operation.
Returns Type: bool
true if the user has at least one of the required scopes; otherwise, false.
Determines if a token is expired based on its claims.
Syntax public bool IsTokenExpired ( System . Security . Claims . ClaimsPrincipal principal )
Parameters Name Type Description principalSystem.Security.Claims.ClaimsPrincipalThe claims principal from a validated token.
Returns Type: bool
true if the token is expired; otherwise, false.
Inherited Syntax protected internal object MemberwiseClone ()
Returns Type: object
Inherited Syntax public static bool ReferenceEquals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Inherited Virtual Syntax public virtual string ToString ()
Returns Type: string?
Validates a JWT token and returns the principal if valid.
Syntax public System . Threading . Tasks . Task < System . Security . Claims . ClaimsPrincipal > ValidateTokenAsync ( string token , System . Threading . CancellationToken cancellationToken = null )
Parameters Name Type Description tokenstringThe JWT token to validate. cancellationTokenSystem.Threading.CancellationTokenA cancellation token to cancel the operation.
Returns Type: System.Threading.Tasks.Task<System.Security.Claims.ClaimsPrincipal?>
A task that represents the asynchronous validation operation. The task result contains the claims principal if the token is valid, or null if invalid.
Validates a JWT token with additional validation parameters.
Syntax public System . Threading . Tasks . Task < Microsoft . OData . Mcp . Authentication . Models . TokenValidationResult > ValidateTokenAsync ( string token , System . Collections . Generic . Dictionary < string , object > validationParameters , System . Threading . CancellationToken cancellationToken = null )
Parameters Name Type Description tokenstringThe JWT token to validate. validationParametersSystem.Collections.Generic.Dictionary<string, object>Additional validation parameters to apply. cancellationTokenSystem.Threading.CancellationTokenA cancellation token to cancel the operation.
Returns Type: System.Threading.Tasks.Task<Microsoft.OData.Mcp.Authentication.Models.TokenValidationResult>
A task that represents the asynchronous validation operation. The task result contains the validation result.
Microsoft.OData.Mcp.Authentication.Services.ITokenValidationService
