OpenIdConnectHandler.GetUserInformationAsync Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Authentication.OpenIdConnect

Assembly:: Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v1.0.0

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v1.1.0

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v2.0.0

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v2.1.0

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v2.2.0

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v3.0.3

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v3.1.18

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v5.0.9

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v6.0.6

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v7.0.5

Package:: Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

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.

Overloads

GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, AuthenticationTicket)	Goes to UserInfo endpoint to retrieve additional claims and add any unique claims to the given identity.
GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, ClaimsPrincipal, AuthenticationProperties)	Goes to UserInfo endpoint to retrieve additional claims and add any unique claims to the given identity.

GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, AuthenticationTicket)

Goes to UserInfo endpoint to retrieve additional claims and add any unique claims to the given identity.

protected:
 virtual System::Threading::Tasks::Task<Microsoft::AspNetCore::Authentication::AuthenticateResult ^> ^ GetUserInformationAsync(Microsoft::IdentityModel::Protocols::OpenIdConnect::OpenIdConnectMessage ^ message, System::IdentityModel::Tokens::Jwt::JwtSecurityToken ^ jwt, Microsoft::AspNetCore::Authentication::AuthenticationTicket ^ ticket);

protected virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticateResult> GetUserInformationAsync (Microsoft.IdentityModel.Protocols.OpenIdConnect.OpenIdConnectMessage message, System.IdentityModel.Tokens.Jwt.JwtSecurityToken jwt, Microsoft.AspNetCore.Authentication.AuthenticationTicket ticket);

abstract member GetUserInformationAsync : Microsoft.IdentityModel.Protocols.OpenIdConnect.OpenIdConnectMessage * System.IdentityModel.Tokens.Jwt.JwtSecurityToken * Microsoft.AspNetCore.Authentication.AuthenticationTicket -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticateResult>
override this.GetUserInformationAsync : Microsoft.IdentityModel.Protocols.OpenIdConnect.OpenIdConnectMessage * System.IdentityModel.Tokens.Jwt.JwtSecurityToken * Microsoft.AspNetCore.Authentication.AuthenticationTicket -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticateResult>

Protected Overridable Function GetUserInformationAsync (message As OpenIdConnectMessage, jwt As JwtSecurityToken, ticket As AuthenticationTicket) As Task(Of AuthenticateResult)

Parameters

message: OpenIdConnectMessage

message that is being processed

jwt: JwtSecurityToken

The JwtSecurityToken.

ticket: AuthenticationTicket

authentication ticket with claims principal and identities

Returns

Task<AuthenticateResult>

Authentication ticket with identity with additional claims, if any.

Applies to

GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, ClaimsPrincipal, AuthenticationProperties)

Source:: OpenIdConnectHandler.cs

Source:: OpenIdConnectHandler.cs

Source:: OpenIdConnectHandler.cs

Source:: OpenIdConnectHandler.cs

Source:: OpenIdConnectHandler.cs

Source:: OpenIdConnectHandler.cs

Source:: OpenIdConnectHandler.cs

Source:: OpenIdConnectHandler.cs

Goes to UserInfo endpoint to retrieve additional claims and add any unique claims to the given identity.

protected:
 virtual System::Threading::Tasks::Task<Microsoft::AspNetCore::Authentication::HandleRequestResult ^> ^ GetUserInformationAsync(Microsoft::IdentityModel::Protocols::OpenIdConnect::OpenIdConnectMessage ^ message, System::IdentityModel::Tokens::Jwt::JwtSecurityToken ^ jwt, System::Security::Claims::ClaimsPrincipal ^ principal, Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties);

protected virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.HandleRequestResult> GetUserInformationAsync (Microsoft.IdentityModel.Protocols.OpenIdConnect.OpenIdConnectMessage message, System.IdentityModel.Tokens.Jwt.JwtSecurityToken jwt, System.Security.Claims.ClaimsPrincipal principal, Microsoft.AspNetCore.Authentication.AuthenticationProperties properties);

abstract member GetUserInformationAsync : Microsoft.IdentityModel.Protocols.OpenIdConnect.OpenIdConnectMessage * System.IdentityModel.Tokens.Jwt.JwtSecurityToken * System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Authentication.AuthenticationProperties -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.HandleRequestResult>
override this.GetUserInformationAsync : Microsoft.IdentityModel.Protocols.OpenIdConnect.OpenIdConnectMessage * System.IdentityModel.Tokens.Jwt.JwtSecurityToken * System.Security.Claims.ClaimsPrincipal * Microsoft.AspNetCore.Authentication.AuthenticationProperties -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.HandleRequestResult>

Protected Overridable Function GetUserInformationAsync (message As OpenIdConnectMessage, jwt As JwtSecurityToken, principal As ClaimsPrincipal, properties As AuthenticationProperties) As Task(Of HandleRequestResult)