Class OpenIddictRequest

Namespace

OpenIddict.Abstractions

Assembly

OpenIddict.Abstractions.dll

Represents a generic OpenIddict request.

[JsonConverter(typeof(OpenIddictConverter))]
public class OpenIddictRequest : OpenIddictMessage

Inheritance

object

OpenIddictMessage

OpenIddictRequest

Inherited Members

OpenIddictMessage.AddParameter(string, OpenIddictParameter)

OpenIddictMessage.GetParameter(string)

OpenIddictMessage.GetParameters()

OpenIddictMessage.HasParameter(string)

OpenIddictMessage.RemoveParameter(string)

OpenIddictMessage.SetParameter(string, OpenIddictParameter?)

OpenIddictMessage.TryGetParameter(string, out OpenIddictParameter)

OpenIddictMessage.ToString()

OpenIddictMessage.WriteTo(Utf8JsonWriter)

OpenIddictMessage.this[string]

OpenIddictMessage.Count

OpenIddictMessage.Parameters

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

OpenIddictExtensions.GetAcrValues(OpenIddictRequest)

OpenIddictExtensions.GetPrompts(OpenIddictRequest)

OpenIddictExtensions.GetResponseTypes(OpenIddictRequest)

OpenIddictExtensions.GetScopes(OpenIddictRequest)

OpenIddictExtensions.HasAcrValue(OpenIddictRequest, string)

OpenIddictExtensions.HasPrompt(OpenIddictRequest, string)

OpenIddictExtensions.HasResponseType(OpenIddictRequest, string)

OpenIddictExtensions.HasScope(OpenIddictRequest, string)

OpenIddictExtensions.IsAuthorizationCodeFlow(OpenIddictRequest)

OpenIddictExtensions.IsAuthorizationCodeGrantType(OpenIddictRequest)

OpenIddictExtensions.IsClientCredentialsGrantType(OpenIddictRequest)

OpenIddictExtensions.IsDeviceCodeGrantType(OpenIddictRequest)

OpenIddictExtensions.IsFormPostResponseMode(OpenIddictRequest)

OpenIddictExtensions.IsFragmentResponseMode(OpenIddictRequest)

OpenIddictExtensions.IsHybridFlow(OpenIddictRequest)

OpenIddictExtensions.IsImplicitFlow(OpenIddictRequest)

OpenIddictExtensions.IsNoneFlow(OpenIddictRequest)

OpenIddictExtensions.IsPasswordGrantType(OpenIddictRequest)

OpenIddictExtensions.IsQueryResponseMode(OpenIddictRequest)

OpenIddictExtensions.IsRefreshTokenGrantType(OpenIddictRequest)

Remarks

Security notice: developers instantiating this type are responsible for ensuring that the imported parameters are safe and won't cause the resulting message to grow abnormally, which may result in an excessive memory consumption and a potential denial of service.

Constructors

OpenIddictRequest()

Initializes a new OpenIddict request.

public OpenIddictRequest()

OpenIddictRequest(IEnumerable<KeyValuePair<string, StringValues>>)

Initializes a new OpenIddict request.

public OpenIddictRequest(IEnumerable<KeyValuePair<string, StringValues>> parameters)

Parameters

parameters IEnumerable<KeyValuePair<string, StringValues>>

The request parameters.

Remarks

Parameters with a null or empty key are always ignored.

OpenIddictRequest(IEnumerable<KeyValuePair<string, OpenIddictParameter>>)

Initializes a new OpenIddict request.

public OpenIddictRequest(IEnumerable<KeyValuePair<string, OpenIddictParameter>> parameters)

Parameters

parameters IEnumerable<KeyValuePair<string, OpenIddictParameter>>

The request parameters.

Remarks

Parameters with a null or empty key are always ignored.

OpenIddictRequest(IEnumerable<KeyValuePair<string, string?[]?>>)

Initializes a new OpenIddict request.

public OpenIddictRequest(IEnumerable<KeyValuePair<string, string?[]?>> parameters)

Parameters

parameters IEnumerable<KeyValuePair<string, string[]>>

The request parameters.

Remarks

Parameters with a null or empty key are always ignored.

OpenIddictRequest(IEnumerable<KeyValuePair<string, string?>>)

Initializes a new OpenIddict request.

public OpenIddictRequest(IEnumerable<KeyValuePair<string, string?>> parameters)

Parameters

parameters IEnumerable<KeyValuePair<string, string>>

The request parameters.

Remarks

Parameters with a null or empty key are always ignored.

OpenIddictRequest(NameValueCollection)

Initializes a new OpenIddict request.

public OpenIddictRequest(NameValueCollection parameters)

Parameters

parameters NameValueCollection

The request parameters.

Remarks

Parameters with a null or empty key are always ignored.

OpenIddictRequest(JsonElement)

Initializes a new OpenIddict request.

public OpenIddictRequest(JsonElement parameters)

Parameters

parameters JsonElement

The request parameters.

Remarks

Parameters with a null or empty key are always ignored.

OpenIddictRequest(JsonObject)

Initializes a new OpenIddict request.

public OpenIddictRequest(JsonObject parameters)

Parameters

parameters JsonObject

The request parameters.

Remarks

Parameters with a null or empty key are always ignored.

Properties

AccessToken

Gets or sets the "access_token" parameter.

public string? AccessToken { get; set; }

Property Value

string

AcrValues

Gets or sets the "acr_values" parameter.

public string? AcrValues { get; set; }

Property Value

string

Assertion

Gets or sets the "assertion" parameter.

public string? Assertion { get; set; }

Property Value

string

Audiences

Gets or sets the "audience" parameters.

public string?[]? Audiences { get; set; }

Property Value

string[]

Claims

Gets or sets the "claims" parameter.

public JsonElement Claims { get; set; }

Property Value

JsonElement

ClaimsLocales

Gets or sets the "claims_locales" parameter.

public string? ClaimsLocales { get; set; }

Property Value

string

ClientAssertion

Gets or sets the "client_assertion" parameter.

public string? ClientAssertion { get; set; }

Property Value

string

ClientAssertionType

Gets or sets the "client_assertion_type" parameter.

public string? ClientAssertionType { get; set; }

Property Value

string

ClientId

Gets or sets the "client_id" parameter.

public string? ClientId { get; set; }

Property Value

string

ClientSecret

Gets or sets the "client_secret" parameter.

public string? ClientSecret { get; set; }

Property Value

string

Code

Gets or sets the "code" parameter.

public string? Code { get; set; }

Property Value

string

CodeChallenge

Gets or sets the "code_challenge" parameter.

public string? CodeChallenge { get; set; }

Property Value

string

CodeChallengeMethod

Gets or sets the "code_challenge_method" parameter.

public string? CodeChallengeMethod { get; set; }

Property Value

string

CodeVerifier

Gets or sets the "code_verifier" parameter.

public string? CodeVerifier { get; set; }

Property Value

string

DeviceCode

Gets or sets the "device_code" parameter.

public string? DeviceCode { get; set; }

Property Value

string

Display

Gets or sets the "display" parameter.

public string? Display { get; set; }

Property Value

string

GrantType

Gets or sets the "grant_type" parameter.

public string? GrantType { get; set; }

Property Value

string

IdToken

Gets or sets the "id_token" parameter.

public string? IdToken { get; set; }

Property Value

string

IdTokenHint

Gets or sets the "id_token_hint" parameter.

public string? IdTokenHint { get; set; }

Property Value

string

IdentityProvider

Gets or sets the "identity_provider" parameter.

public string? IdentityProvider { get; set; }

Property Value

string

LoginHint

Gets or sets the "login_hint" parameter.

public string? LoginHint { get; set; }

Property Value

string

MaxAge

Gets or sets the "max_age" parameter.

public long? MaxAge { get; set; }

Property Value

long?

Nonce

Gets or sets the "nonce" parameter.

public string? Nonce { get; set; }

Property Value

string

Password

Gets or sets the "password" parameter.

public string? Password { get; set; }

Property Value

string

PostLogoutRedirectUri

Gets or sets the "post_logout_redirect_uri" parameter.

public string? PostLogoutRedirectUri { get; set; }

Property Value

string

Prompt

Gets or sets the "prompt" parameter.

public string? Prompt { get; set; }

Property Value

string

RedirectUri

Gets or sets the "redirect_uri" parameter.

public string? RedirectUri { get; set; }

Property Value

string

RefreshToken

Gets or sets the "refresh_token" parameter.

public string? RefreshToken { get; set; }

Property Value

string

Registration

Gets or sets the "registration" parameter.

public JsonElement Registration { get; set; }

Property Value

JsonElement

Request

Gets or sets the "request" parameter.

public string? Request { get; set; }

Property Value

string

RequestId

Gets or sets the "request_id" parameter.

public string? RequestId { get; set; }

Property Value

string

RequestUri

Gets or sets the "request_uri" parameter.

public string? RequestUri { get; set; }

Property Value

string

Resources

Gets or sets the "resource" parameters.

public string?[]? Resources { get; set; }

Property Value

string[]

ResponseMode

Gets or sets the "response_mode" parameter.

public string? ResponseMode { get; set; }

Property Value

string

ResponseType

Gets or sets the "response_type" parameter.

public string? ResponseType { get; set; }

Property Value

string

Scope

Gets or sets the "scope" parameter.

public string? Scope { get; set; }

Property Value

string

State

Gets or sets the "state" parameter.

public string? State { get; set; }

Property Value

string

Token

Gets or sets the "token" parameter.

public string? Token { get; set; }

Property Value

string

TokenTypeHint

Gets or sets the "token_type_hint" parameter.

public string? TokenTypeHint { get; set; }

Property Value

string

UiLocales

Gets or sets the "ui_locales" parameter.

public string? UiLocales { get; set; }

Property Value

string

UserCode

Gets or sets the "user_code" parameter.

public string? UserCode { get; set; }

Property Value

string

Username

Gets or sets the "username" parameter.

public string? Username { get; set; }

Property Value

string