OpenIdConnectMessage Class

Definition

Namespace:

Microsoft.IdentityModel.Protocols.OpenIdConnect

Assembly:

Microsoft.IdentityModel.Protocols.OpenIdConnect.dll

Package:

Microsoft.IdentityModel.Protocols.OpenIdConnect v8.2.0

Provides access to common OpenID Connect parameters.

public class OpenIdConnectMessage : Microsoft.IdentityModel.Protocols.AuthenticationProtocolMessage

type OpenIdConnectMessage = class
    inherit AuthenticationProtocolMessage

Public Class OpenIdConnectMessage
Inherits AuthenticationProtocolMessage

Inheritance

Object

AuthenticationProtocolMessage

OpenIdConnectMessage

Constructors

OpenIdConnectMessage()	Initializes a new instance of the OpenIdConnectMessage class.
OpenIdConnectMessage(IEnumerable<KeyValuePair<String,String[]>>)	Initializes a new instance of the OpenIdConnectMessage class.
OpenIdConnectMessage(NameValueCollection)	Initializes a new instance of the OpenIdConnectMessage class.
OpenIdConnectMessage(OpenIdConnectMessage)	Initializes a new instance of the OpenIdConnectMessage class.
OpenIdConnectMessage(String)	Initializes a new instance of OpenIdConnectMessage class with a json string.

Properties

AccessToken	Gets or sets 'access_Token'.
AcrValues	Gets or sets 'acr_values'.
AuthorizationEndpoint	Gets or sets the value for the AuthorizationEndpoint
ClaimsLocales	Gets or sets 'claims_Locales'.
ClientAssertion	Gets or sets 'client_assertion'.
ClientAssertionType	Gets or sets 'client_assertion_type'.
ClientId	Gets or sets 'client_id'.
ClientSecret	Gets or sets 'client_secret'.
Code	Gets or sets 'code'.
Display	Gets or sets 'display'.
DomainHint	Gets or sets 'domain_hint'.
EnableTelemetryParameters	Gets or sets whether parameters for the library and version are sent on the query string for this OpenIdConnectMessage instance. This value is set to the value of EnableTelemetryParametersByDefault at message creation time.
EnableTelemetryParametersByDefault	Gets or sets whether parameters for the library and version are sent on the query string for all instances of OpenIdConnectMessage.
Error	Gets or sets 'error'.
ErrorDescription	Gets or sets 'error_description'.
ErrorUri	Gets or sets 'error_uri'.
ExpiresIn	Gets or sets 'expires_in'.
GrantType	Gets or sets 'grant_type'.
IdentityProvider	Gets or sets 'identity_provider'.
IdToken	Gets or sets 'id_token'.
IdTokenHint	Gets or sets 'id_token_hint'.
Iss	Gets or sets 'iss'.
IssuerAddress	Gets or sets the issuer address. (Inherited from AuthenticationProtocolMessage)
LoginHint	Gets or sets 'login_hint'.
MaxAge	Gets or sets 'max_age'.
Nonce	Gets or sets 'nonce'.
Parameters	Gets the message parameters as a Dictionary. (Inherited from AuthenticationProtocolMessage)
Password	Gets or sets 'password'.
PostLogoutRedirectUri	Gets or sets 'post_logout_redirect_uri'.
PostTitle	Gets or sets the title used when constructing the post string. (Inherited from AuthenticationProtocolMessage)
Prompt	Gets or sets 'prompt'.
RedirectUri	Gets or sets 'redirect_uri'.
RefreshToken	Gets or sets 'refresh_token'.
RequestType	Gets or set the request type for this message
RequestUri	Gets or sets 'request_uri'.
Resource	Gets or sets 'resource'
ResponseMode	Gets or sets 'response_mode'.
ResponseType	Gets or sets 'response_type'.
Scope	Gets or sets 'scope'.
Script	Gets the script used when constructing the post string. (Inherited from AuthenticationProtocolMessage)
ScriptButtonText	Gets or sets the script button text used when constructing the post string. (Inherited from AuthenticationProtocolMessage)
ScriptDisabledText	Gets or sets the text used when constructing the post string that will be displayed to used if script is disabled. (Inherited from AuthenticationProtocolMessage)
SessionState	Gets or sets 'session_state'.
Sid	Gets or sets 'sid'.
SkuTelemetryValue	Gets the string that is sent as telemetry data in an OpenIdConnectMessage.
State	Gets or sets 'state'.
TargetLinkUri	Gets or sets 'target_link_uri'.
TokenEndpoint	Gets or sets the value for the token endpoint.
TokenType	Gets or sets 'token_type'.
UiLocales	Gets or sets 'ui_locales'.
UserId	Gets or sets 'user_id'.
Username	Gets or sets 'username'.

Methods

BuildFormPost()	Builds a form post using the current IssuerAddress and the parameters that have been set. (Inherited from AuthenticationProtocolMessage)
BuildRedirectUrl()	Builds a URL using the current IssuerAddress and the parameters that have been set. (Inherited from AuthenticationProtocolMessage)
Clone()	Returns a new instance of OpenIdConnectMessage with values copied from this object.
CreateAuthenticationRequestUrl()	Creates an OpenIdConnect message using the current contents of this OpenIdConnectMessage.
CreateLogoutRequestUrl()	Creates a query string using the current contents of this OpenIdConnectMessage.
GetParameter(String)	Returns a parameter. (Inherited from AuthenticationProtocolMessage)
RemoveParameter(String)	Removes a parameter. (Inherited from AuthenticationProtocolMessage)
SetParameter(String, String)	Sets a parameter to the Parameters Dictionary. (Inherited from AuthenticationProtocolMessage)
SetParameters(NameValueCollection)	Sets a collection parameters. (Inherited from AuthenticationProtocolMessage)