Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class Duende.IdentityServer.Configuration.UserInteractionOptions
Assembly: Duende.IdentityServer
Inheritance: object → UserInteractionOptions
Settings for user-facing UI pages, including URLs, query parameter names, and other behavior related to interactive authorization flows.
Properties
public
string
LoginUrl
Gets or sets the URL of the login page. Local URLs must begin with a leading slash.
Remarks When not set, IdentityServer uses the default route configured by the UI template.
public
string
LoginReturnUrlParameter
Gets or sets the name of the query parameter appended to the login URL that carries the return URL
after successful authentication.
Remarks Defaults to <c>"returnUrl"</c> .
public
string
LogoutUrl
Gets or sets the URL of the logout page. Local URLs must begin with a leading slash.
Remarks When not set, IdentityServer uses the default route configured by the UI template.
public
string
LogoutIdParameter
Gets or sets the name of the query parameter appended to the logout URL that carries the logout
message identifier.
Remarks Defaults to <c>"logoutId"</c> .
public
string
ConsentUrl
Gets or sets the URL of the consent page. Local URLs must begin with a leading slash.
Remarks Defaults to <c>"/consent"</c> .
public
string
ConsentReturnUrlParameter
Gets or sets the name of the query parameter appended to the consent URL that carries the return URL
after the user grants or denies consent.
Remarks Defaults to <c>"returnUrl"</c> .
public
string
CreateAccountUrl
Gets or sets the URL of the account creation (registration) page, used when an authorization request
includes <c>prompt=create</c> . Local URLs must begin with a leading slash.
Remarks Defaults to <c>null</c> . When set, the <c>prompt=create</c> parameter redirects users
to this URL, and <c>"create"</c> is added to the <c>prompt_values_supported</c> array
in the discovery document. When not set, <c>prompt=create</c> is ignored.
public
string
CreateAccountReturnUrlParameter
Gets or sets the name of the query parameter appended to the create-account URL that carries the
return URL after account creation.
Remarks Defaults to <c>"returnUrl"</c> .
public
string
ErrorUrl
Gets or sets the URL of the error page. Local URLs must begin with a leading slash.
Remarks Defaults to <c>"/error"</c> .
public
string
ErrorIdParameter
Gets or sets the name of the query parameter appended to the error URL that carries the error message
identifier.
Remarks Defaults to <c>"errorId"</c> .
public
string
CustomRedirectReturnUrlParameter
Gets or sets the name of the query parameter appended to a custom redirect URL from the authorization
endpoint that carries the return URL.
Remarks Defaults to <c>"returnUrl"</c> .
public
int
CookieMessageThreshold
Gets or sets the maximum number of message cookies of any type that IdentityServer will create.
Older cookies are purged once this limit is reached.
Remarks Defaults to 2. This limit exists because browsers cap the total number and size of
cookies per domain. In practice, this value controls how many concurrent browser tabs a
user can have open while interacting with IdentityServer.
public
string
DeviceVerificationUrl
Gets or sets the URL of the device verification page used in the OAuth 2.0 Device Authorization
Grant. Local URLs must begin with a leading slash.
Remarks Defaults to <c>"/device"</c> .
public
string
DeviceVerificationUserCodeParameter
Gets or sets the name of the query parameter appended to the device verification URL that carries
the user code.
Remarks Defaults to <c>"userCode"</c> .
public
bool
AllowOriginInReturnUrl
Gets or sets a value indicating whether return URL validation accepts absolute URLs that include the IdentityServer
origin.
Remarks Defaults to <c>false</c> . When <c>true</c> , return URLs such as
<c>https://identity.example.com/connect/authorize/callback</c> are accepted in addition
to relative paths.
public
System.Collections.Generic.ICollection<string>
PromptValuesSupported
Gets or sets the collection of OIDC <c>prompt</c> parameter values that IdentityServer supports and
publishes in the <c>prompt_values_supported</c> discovery document array.
Remarks By default, this includes all values in <see cref="F:Duende.IdentityServer.Constants.SupportedPromptModes" /> .
When <see cref="P:Duende.IdentityServer.Configuration.UserInteractionOptions.CreateAccountUrl" /> is set, <c>"create"</c> is also included
automatically. Adding custom prompt values requires a corresponding customization of
<see cref="T:Duende.IdentityServer.ResponseHandling.IAuthorizeInteractionResponseGenerator" /> to handle those values.
Methods
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object