2021-01-18 02:24:47 +08:00
<!DOCTYPE html>
<!-- [if IE]><![endif] -->
< html >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge,chrome=1" >
< title > Class OpenIddictValidationService
< / title >
< meta name = "viewport" content = "width=device-width" >
< meta name = "title" content = "Class OpenIddictValidationService
">
< meta name = "generator" content = "docfx 2.56.6.0" >
< link rel = "shortcut icon" href = "../images/favicon.ico" >
< link rel = "stylesheet" href = "../styles/docfx.vendor.css" >
< link rel = "stylesheet" href = "../styles/docfx.css" >
< link rel = "stylesheet" href = "../styles/main.css" >
< link href = "https://fonts.googleapis.com/css?family=Roboto" rel = "stylesheet" >
< meta property = "docfx:navrel" content = "../toc.html" >
< meta property = "docfx:tocrel" content = "toc.html" >
< / head > < body data-spy = "scroll" data-target = "#affix" data-offset = "120" >
< div id = "wrapper" >
< header >
< nav id = "autocollapse" class = "navbar navbar-inverse ng-scope" role = "navigation" >
< div class = "container" >
< div class = "navbar-header" >
< button type = "button" class = "navbar-toggle" data-toggle = "collapse" data-target = "#navbar" >
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "navbar-brand" href = "../index.html" >
< img id = "logo" class = "svg" src = "../images/logo.png" alt = "" >
< / a > < / div >
< div class = "collapse navbar-collapse" id = "navbar" >
< form class = "navbar-form navbar-right" role = "search" id = "search" >
< div class = "form-group" >
< input type = "text" class = "form-control" id = "search-query" placeholder = "Search" autocomplete = "off" >
< / div >
< / form >
< / div >
< / div >
< / nav >
< div class = "subnav navbar navbar-default" >
< div class = "container hide-when-search" id = "breadcrumb" >
< ul class = "breadcrumb" >
< li > < / li >
< / ul >
< / div >
< / div >
< / header >
< div role = "main" class = "container body-content hide-when-search" >
< div class = "sidenav hide-when-search" >
< a class = "btn toc-toggle collapse" data-toggle = "collapse" href = "#sidetoggle" aria-expanded = "false" aria-controls = "sidetoggle" > Show / Hide Table of Contents< / a >
< div class = "sidetoggle collapse" id = "sidetoggle" >
< div id = "sidetoc" > < / div >
< / div >
< / div >
< div class = "article row grid-right" >
< div class = "col-md-10" >
< article class = "content wrap" id = "_content" data-uid = "OpenIddict.Validation.OpenIddictValidationService" >
< h1 id = "OpenIddict_Validation_OpenIddictValidationService" data-uid = "OpenIddict.Validation.OpenIddictValidationService" class = "text-break" > Class OpenIddictValidationService
< / h1 >
< div class = "markdown level0 summary" > < / div >
< div class = "markdown level0 conceptual" > < / div >
< div class = "inheritance" >
< h5 > Inheritance< / h5 >
< div class = "level0" > < span class = "xref" > System.Object< / span > < / div >
< div class = "level1" > < span class = "xref" > OpenIddictValidationService< / span > < / div >
< / div >
< div class = "inheritedMembers" >
< h5 > Inherited Members< / h5 >
< div >
< span class = "xref" > System.Object.Equals(System.Object)< / span >
< / div >
< div >
< span class = "xref" > System.Object.Equals(System.Object, System.Object)< / span >
< / div >
< div >
< span class = "xref" > System.Object.GetHashCode()< / span >
< / div >
< div >
< span class = "xref" > System.Object.GetType()< / span >
< / div >
< div >
< span class = "xref" > System.Object.MemberwiseClone()< / span >
< / div >
< div >
< span class = "xref" > System.Object.ToString()< / span >
< / div >
< div >
< span class = "xref" > System.Object.ReferenceEquals(System.Object, System.Object)< / span >
< / div >
< / div >
< h6 > < strong > Namespace< / strong > : < a class = "xref" href = "OpenIddict.Validation.html" > OpenIddict.Validation< / a > < / h6 >
< h6 > < strong > Assembly< / strong > : cs.temp.dll.dll< / h6 >
< h5 id = "OpenIddict_Validation_OpenIddictValidationService_syntax" > Syntax< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public class OpenIddictValidationService< / code > < / pre >
< / div >
< h3 id = "constructors" > Constructors
< / h3 >
< a id = "OpenIddict_Validation_OpenIddictValidationService__ctor_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.#ctor*" > < / a >
< h4 id = "OpenIddict_Validation_OpenIddictValidationService__ctor_System_IServiceProvider_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.#ctor(System.IServiceProvider)" > OpenIddictValidationService(IServiceProvider)< / h4 >
< div class = "markdown level1 summary" > < p > Creates a new instance of the < a class = "xref" href = "OpenIddict.Validation.OpenIddictValidationService.html" > OpenIddictValidationService< / a > class.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public OpenIddictValidationService(IServiceProvider provider)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.IServiceProvider< / span > < / td >
< td > < span class = "parametername" > provider< / span > < / td >
< td > < p > The service provider.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "methods" > Methods
< / h3 >
< a id = "OpenIddict_Validation_OpenIddictValidationService_GetConfigurationAsync_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.GetConfigurationAsync*" > < / a >
< h4 id = "OpenIddict_Validation_OpenIddictValidationService_GetConfigurationAsync_Uri_CancellationToken_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.GetConfigurationAsync(Uri,CancellationToken)" > GetConfigurationAsync(Uri, CancellationToken)< / h4 >
< div class = "markdown level1 summary" > < p > Retrieves the OpenID Connect server configuration from the specified address.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public ValueTask< OpenIdConnectConfiguration> GetConfigurationAsync(Uri address, CancellationToken cancellationToken = null)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > Uri< / span > < / td >
< td > < span class = "parametername" > address< / span > < / td >
< td > < p > The address of the remote metadata endpoint.< / p >
< / td >
< / tr >
< tr >
< td > < span class = "xref" > CancellationToken< / span > < / td >
< td > < span class = "parametername" > cancellationToken< / span > < / td >
< td > < p > The < see cref = "!:CancellationToken" > < / see > that can be used to abort the operation.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > ValueTask< / span > < < span class = "xref" > OpenIdConnectConfiguration< / span > > < / td >
2021-01-18 02:24:47 +08:00
< td > < p > The OpenID Connect server configuration retrieved from the remote server.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Validation_OpenIddictValidationService_GetSecurityKeysAsync_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.GetSecurityKeysAsync*" > < / a >
< h4 id = "OpenIddict_Validation_OpenIddictValidationService_GetSecurityKeysAsync_Uri_CancellationToken_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.GetSecurityKeysAsync(Uri,CancellationToken)" > GetSecurityKeysAsync(Uri, CancellationToken)< / h4 >
< div class = "markdown level1 summary" > < p > Retrieves the security keys exposed by the specified JWKS endpoint.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public ValueTask< JsonWebKeySet> GetSecurityKeysAsync(Uri address, CancellationToken cancellationToken = null)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > Uri< / span > < / td >
< td > < span class = "parametername" > address< / span > < / td >
< td > < p > The address of the remote metadata endpoint.< / p >
< / td >
< / tr >
< tr >
< td > < span class = "xref" > CancellationToken< / span > < / td >
< td > < span class = "parametername" > cancellationToken< / span > < / td >
< td > < p > The < see cref = "!:CancellationToken" > < / see > that can be used to abort the operation.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > ValueTask< / span > < < span class = "xref" > JsonWebKeySet< / span > > < / td >
2021-01-18 02:24:47 +08:00
< td > < p > The security keys retrieved from the remote server.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Validation_OpenIddictValidationService_IntrospectTokenAsync_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.IntrospectTokenAsync*" > < / a >
< h4 id = "OpenIddict_Validation_OpenIddictValidationService_IntrospectTokenAsync_Uri_System_String_CancellationToken_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.IntrospectTokenAsync(Uri,System.String,CancellationToken)" > IntrospectTokenAsync(Uri, String, CancellationToken)< / h4 >
< div class = "markdown level1 summary" > < p > Sends an introspection request to the specified address and returns the corresponding principal.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public ValueTask< ClaimsPrincipal> IntrospectTokenAsync(Uri address, string token, CancellationToken cancellationToken = null)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > Uri< / span > < / td >
< td > < span class = "parametername" > address< / span > < / td >
< td > < p > The address of the remote metadata endpoint.< / p >
< / td >
< / tr >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > token< / span > < / td >
< td > < p > The token to introspect.< / p >
< / td >
< / tr >
< tr >
< td > < span class = "xref" > CancellationToken< / span > < / td >
< td > < span class = "parametername" > cancellationToken< / span > < / td >
< td > < p > The < see cref = "!:CancellationToken" > < / see > that can be used to abort the operation.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > ValueTask< / span > < < span class = "xref" > ClaimsPrincipal< / span > > < / td >
2021-01-18 02:24:47 +08:00
< td > < p > The claims principal created from the claim retrieved from the remote server.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Validation_OpenIddictValidationService_IntrospectTokenAsync_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.IntrospectTokenAsync*" > < / a >
< h4 id = "OpenIddict_Validation_OpenIddictValidationService_IntrospectTokenAsync_Uri_System_String_System_String_CancellationToken_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.IntrospectTokenAsync(Uri,System.String,System.String,CancellationToken)" > IntrospectTokenAsync(Uri, String, String, CancellationToken)< / h4 >
< div class = "markdown level1 summary" > < p > Sends an introspection request to the specified address and returns the corresponding principal.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public ValueTask< ClaimsPrincipal> IntrospectTokenAsync(Uri address, string token, string type, CancellationToken cancellationToken = null)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > Uri< / span > < / td >
< td > < span class = "parametername" > address< / span > < / td >
< td > < p > The address of the remote metadata endpoint.< / p >
< / td >
< / tr >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > token< / span > < / td >
< td > < p > The token to introspect.< / p >
< / td >
< / tr >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > type< / span > < / td >
< td > < p > The token type to introspect.< / p >
< / td >
< / tr >
< tr >
< td > < span class = "xref" > CancellationToken< / span > < / td >
< td > < span class = "parametername" > cancellationToken< / span > < / td >
< td > < p > The < see cref = "!:CancellationToken" > < / see > that can be used to abort the operation.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > ValueTask< / span > < < span class = "xref" > ClaimsPrincipal< / span > > < / td >
2021-01-18 02:24:47 +08:00
< td > < p > The claims principal created from the claim retrieved from the remote server.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Validation_OpenIddictValidationService_ValidateAccessTokenAsync_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.ValidateAccessTokenAsync*" > < / a >
< h4 id = "OpenIddict_Validation_OpenIddictValidationService_ValidateAccessTokenAsync_System_String_CancellationToken_" data-uid = "OpenIddict.Validation.OpenIddictValidationService.ValidateAccessTokenAsync(System.String,CancellationToken)" > ValidateAccessTokenAsync(String, CancellationToken)< / h4 >
< div class = "markdown level1 summary" > < p > Validates the specified access token and returns the principal extracted from the token.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public ValueTask< ClaimsPrincipal> ValidateAccessTokenAsync(string token, CancellationToken cancellationToken = null)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.String< / span > < / td >
< td > < span class = "parametername" > token< / span > < / td >
< td > < p > The access token to validate.< / p >
< / td >
< / tr >
< tr >
< td > < span class = "xref" > CancellationToken< / span > < / td >
< td > < span class = "parametername" > cancellationToken< / span > < / td >
< td > < p > The < see cref = "!:CancellationToken" > < / see > that can be used to abort the operation.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > ValueTask< / span > < < span class = "xref" > ClaimsPrincipal< / span > > < / td >
2021-01-18 02:24:47 +08:00
< td > < p > The principal containing the claims extracted from the token.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / article >
< / div >
< div class = "hidden-sm col-md-2" role = "complementary" >
< div class = "sideaffix" >
< div class = "contribution" >
< ul class = "nav" >
< / ul >
< / div >
< nav class = "bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id = "affix" >
< h5 > In This Article< / h5 >
< div > < / div >
< / nav >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "grad-bottom" > < / div >
< div class = "footer" >
< div class = "container" >
< span class = "pull-right" >
< a href = "#top" > Back to top< / a >
< / span >
< span > Generated by < strong > DocFX< / strong > < / span >
< / div >
< / div >
< / footer >
< / div >
< script type = "text/javascript" src = "../styles/docfx.vendor.js" > < / script >
< script type = "text/javascript" src = "../styles/docfx.js" > < / script >
< script type = "text/javascript" src = "../styles/main.js" > < / script >
< / body >
< / html >
