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.DiscoveryOptions
Assembly: Duende.IdentityServer
Inheritance: object → DiscoveryOptions
Settings for the OpenID Connect discovery document endpoint, including flags to control which sections are included and support for custom entries.
Remarks
To take full control over the rendering of the discovery and JWKS documents, implement
<c>IDiscoveryResponseGenerator</c> or derive from the default implementation.
Properties
public
bool
ShowEndpoints
Gets or sets a value indicating whether endpoint URLs (e.g., <c>authorization_endpoint</c> , <c>token_endpoint</c> ) are included in
the discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ShowKeySet
Gets or sets a value indicating whether the <c>jwks_uri</c> is included in the discovery document and the JWKS endpoint is enabled.
Remarks Defaults to <c>true</c> .
public
bool
ShowIdentityScopes
Gets or sets a value indicating whether identity resources (OpenID scopes) are included in the <c>scopes_supported</c> array of the
discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ShowApiScopes
Gets or sets a value indicating whether API scopes are included in the <c>scopes_supported</c> array of the discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ShowClaims
Gets or sets a value indicating whether the <c>claims_supported</c> array is included in the discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ShowResponseTypes
Gets or sets a value indicating whether the <c>response_types_supported</c> array is included in the discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ShowResponseModes
Gets or sets a value indicating whether the <c>response_modes_supported</c> array is included in the discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ShowGrantTypes
Gets or sets a value indicating whether the <c>grant_types_supported</c> array is included in the discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ShowExtensionGrantTypes
Gets or sets a value indicating whether extension (custom) grant types are included in the <c>grant_types_supported</c> array of the
discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ShowTokenEndpointAuthenticationMethods
Gets or sets a value indicating whether the <c>token_endpoint_auth_methods_supported</c> array is included in the discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ShowRevocationEndpointAuthenticationMethods
Gets or sets a value indicating whether the supported authentication methods for the revocation endpoint are included in the
discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ShowIntrospectionEndpointAuthenticationMethods
Gets or sets a value indicating whether the supported authentication methods for the introspection endpoint are included in the
discovery document.
Remarks Defaults to <c>true</c> .
public
bool
ExpandRelativePathsInCustomEntries
Gets or sets a value indicating whether relative paths that begin with <c>~/</c> in <see cref="P:Duende.IdentityServer.Configuration.DiscoveryOptions.CustomEntries" /> are expanded into
absolute URLs beneath the IdentityServer base address.
Remarks Defaults to <c>true</c> . For example, if IdentityServer is hosted at
<c>https://localhost:5001</c> , a custom entry value of <c>~/custom</c> is expanded to
<c>https://localhost:5001/custom</c> .
DynamicClientRegistration
Gets or sets the options for how the dynamic client registration endpoint is advertised in the discovery
document.
public
int?
ResponseCacheInterval
Gets or sets the <c>max-age</c> value (in seconds) of the <c>Cache-Control</c> response header
on the discovery document. Set to <c>0</c> to emit <c>no-cache</c> headers.
Remarks Defaults to <c>null</c> , which means no <c>Cache-Control</c> header is set. Configuring
this gives clients a hint about how often they should refresh their cached copy of the
discovery document.
public
bool
EnableDiscoveryDocumentCache
Gets or sets a value indicating whether the discovery document is cached in the distributed cache.
Remarks Defaults to <c>false</c> . When enabled, the discovery document is cached using the registered
<c>IDistributedCache</c> for the duration specified by <see cref="P:Duende.IdentityServer.Configuration.DiscoveryOptions.DiscoveryDocumentCacheDuration" /> .
public
System.TimeSpan
DiscoveryDocumentCacheDuration
Gets or sets the duration for which the discovery document is cached in the distributed cache.
Remarks Defaults to 1 minute. Only applies when <see cref="P:Duende.IdentityServer.Configuration.DiscoveryOptions.EnableDiscoveryDocumentCache" /> is <c>true</c> .
public
System.Collections.Generic.Dictionary<string, object>
CustomEntries
Gets or sets the additional key-value entries to include in the discovery document.
Remarks Values that are strings beginning with <c>~/</c> are expanded to absolute URLs when
<see cref="P:Duende.IdentityServer.Configuration.DiscoveryOptions.ExpandRelativePathsInCustomEntries" /> is <c>true</c> .
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