Class OpenIddictResponse

Namespace

OpenIddict.Abstractions

Assembly

OpenIddict.Abstractions.dll

Represents a generic OpenIddict response.

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

Inheritance

object

OpenIddictMessage

OpenIddictResponse

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()

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

OpenIddictResponse()

Initializes a new OpenIddict response.

public OpenIddictResponse()

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

Initializes a new OpenIddict response.

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

Parameters

parameters IEnumerable<KeyValuePair<string, StringValues>>

The response parameters.

Remarks

Parameters with a null or empty key are always ignored.

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

Initializes a new OpenIddict response.

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

Parameters

parameters IEnumerable<KeyValuePair<string, OpenIddictParameter>>

The response parameters.

Remarks

Parameters with a null or empty key are always ignored.

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

Initializes a new OpenIddict response.

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

Parameters

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

The response parameters.

Remarks

Parameters with a null or empty key are always ignored.

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

Initializes a new OpenIddict response.

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

Parameters

parameters IEnumerable<KeyValuePair<string, string>>

The response parameters.

Remarks

Parameters with a null or empty key are always ignored.

OpenIddictResponse(NameValueCollection)

Initializes a new OpenIddict response.

public OpenIddictResponse(NameValueCollection parameters)

Parameters

parameters NameValueCollection

The response parameters.

Remarks

Parameters with a null or empty key are always ignored.

OpenIddictResponse(JsonElement)

Initializes a new OpenIddict response.

public OpenIddictResponse(JsonElement parameters)

Parameters

parameters JsonElement

The response parameters.

Remarks

Parameters with a null or empty key are always ignored.

OpenIddictResponse(JsonObject)

Initializes a new OpenIddict response.

public OpenIddictResponse(JsonObject parameters)

Parameters

parameters JsonObject

The response 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

Code

Gets or sets the "code" parameter.

public string? Code { get; set; }

Property Value

string

DeviceCode

Gets or sets the "device_code" parameter.

public string? DeviceCode { get; set; }

Property Value

string

Error

Gets or sets the "error" parameter.

public string? Error { get; set; }

Property Value

string

ErrorDescription

Gets or sets the "error_description" parameter.

public string? ErrorDescription { get; set; }

Property Value

string

ErrorUri

Gets or sets the "error_uri" parameter.

public string? ErrorUri { get; set; }

Property Value

string

ExpiresIn

Gets or sets the "expires_in" parameter.

public long? ExpiresIn { get; set; }

Property Value

long?

IdToken

Gets or sets the "id_token" parameter.

public string? IdToken { get; set; }

Property Value

string

Iss

Gets or sets the "iss" parameter.

public string? Iss { get; set; }

Property Value

string

RefreshToken

Gets or sets the "refresh_token" parameter.

public string? RefreshToken { 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

TokenType

Gets or sets the "token_type" parameter.

public string? TokenType { get; set; }

Property Value

string

UserCode

Gets or sets the "user_code" parameter.

public string? UserCode { get; set; }

Property Value

string

VerificationUri

Gets or sets the "verification_uri" parameter.

public string? VerificationUri { get; set; }

Property Value

string

VerificationUriComplete

Gets or sets the "verification_uri_complete" parameter.

public string? VerificationUriComplete { get; set; }

Property Value

string