Class AuthenticationRequest

Authentication request.

Inheritance

System.Object

AuthenticationRequest

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: ComponentSpace.OpenID.Messages

Assembly: ComponentSpace.OpenID.dll

Syntax

public class AuthenticationRequest

Properties

AcrValues

Gets or sets the requested authentication context class reference values.

Declaration

public string AcrValues { get; set; }

Property Value

Type	Description
System.String	The requested authentication context class reference values.

Claims

Gets or sets the requested claims.

Declaration

public string Claims { get; set; }

Property Value

Type	Description
System.String	The requested claims.

ClaimsLocales

Gets or sets the claims locales.

Declaration

public string ClaimsLocales { get; set; }

Property Value

Type	Description
System.String	The claims locales.

ClientID

Gets or sets the client ID.

Declaration

public string ClientID { get; set; }

Property Value

Type	Description
System.String	The client ID.

CodeChallenge

Gets or sets the code challenge.

Declaration

public string CodeChallenge { get; set; }

Property Value

Type	Description
System.String	The code challenge.

CodeChallengeMethod

Gets or sets the code challenge method.

Declaration

public string CodeChallengeMethod { get; set; }

Property Value

Type	Description
System.String	The code challenge method.

CorrelationID

Gets or sets the correlation ID used to uniquely identify the request and correlate it with the response.

Declaration

[JsonIgnore]
public string CorrelationID { get; set; }

Property Value

Type	Description
System.String	The correlation ID.

Display

Gets or sets the display mode.

Declaration

public string Display { get; set; }

Property Value

Type	Description
System.String	The display mode.

IdTokenHint

Gets or sets the ID token hint.

Declaration

public string IdTokenHint { get; set; }

Property Value

Type	Description
System.String	The ID token hint.

LoginHint

Gets or sets the login hint.

Declaration

public string LoginHint { get; set; }

Property Value

Type	Description
System.String	The login hint.

MaxAge

Gets or sets the maximum authentication age, in seconds.

Declaration

public string MaxAge { get; set; }

Property Value

Type	Description
System.String	The maximum authentication age, in seconds.

Nonce

Gets or sets the nonce.

Declaration

public string Nonce { get; set; }

Property Value

Type	Description
System.String	The nonce.

Prompt

Gets or sets the prompt mode.

Declaration

public string Prompt { get; set; }

Property Value

Type	Description
System.String	The prompt mode.

RedirectUri

Gets or sets the redirect URI.

Declaration

public string RedirectUri { get; set; }

Property Value

Type	Description
System.String	The redirect URI.

Request

Gets or sets the request as a JWT.

Declaration

public string Request { get; set; }

Property Value

Type	Description
System.String	The request as a JWT.

RequestUri

Gets or sets the request as a URL to a JWT.

Declaration

public string RequestUri { get; set; }

Property Value

Type	Description
System.String	The request as a URL to a JWT.

ResponseMode

Gets or sets the response mode.

Declaration

public string ResponseMode { get; set; }

Property Value

Type	Description
System.String	The response mode.

ResponseType

Gets or sets the response type.

Declaration

public string ResponseType { get; set; }

Property Value

Type	Description
System.String	The response type.

Scope

Gets or sets the scope.

Declaration

public string Scope { get; set; }

Property Value

Type	Description
System.String	The scope.

State

Gets or sets the state.

Declaration

public string State { get; set; }

Property Value

Type	Description
System.String	The state.

UiLocales

Gets or sets the UI locales.

Declaration

public string UiLocales { get; set; }

Property Value

Type	Description
System.String	The UI locales.

Methods

GetClaimsRequest()

Gets the claims request.

Declaration

public AuthenticationRequest.ClaimsRequest GetClaimsRequest()

Returns

Type	Description
AuthenticationRequest.ClaimsRequest	The claims request.

GetFlow()

Returns the flow given the response type.

Declaration

public OpenIDConstants.Flows GetFlow()

Returns

Type	Description
OpenIDConstants.Flows	The flow.

Exceptions

Type	Condition
InvalidRequestException	Thrown if the response type is missing or invalid.

HasScope(String)

Indicates whether the specified scope is included in the authentication request.

Declaration

public bool HasScope(string scope)

Parameters

Type	Name	Description
System.String	scope	The scope.

Returns

Type	Description
System.Boolean	true if the specified scope is included in the authentication request; otherwise false.

IsRequestingAccessToken()

Indicates whether an access token is being requested.

Declaration

public bool IsRequestingAccessToken()

Returns

Type	Description
System.Boolean	true if an access token is being requested; otherwise false.

IsRequestingAuthorizationCode()

Indicates whether an authorization code is being requested.

Declaration

public bool IsRequestingAuthorizationCode()

Returns

Type	Description
System.Boolean	true if an authorization code is being requested; otherwise false.

IsRequestingIDToken()

Indicates whether an ID token is being requested.

Declaration

public bool IsRequestingIDToken()

Returns

Type	Description
System.Boolean	true if an ID token is being requested; otherwise false.