- Set the issuer name that will appear in the discovery document and the issued JWT tokens. It is recommended to not set this property, which infers the issuer name from the host name that is used by the clients.
- Set to
falseto preserve the original casing of the IssuerUri. Defaults to
- Specifies the value used for the JWT typ header for access tokens (defaults to
- Specifies whether scopes in JWTs are emitted as array or string
- Emits an
audclaim with the format issuer/resources. Defaults to false.
Allows enabling/disabling individual endpoints, e.g. token, authorize, userinfo etc.
By default all endpoints are enabled, but you can lock down your server by disabling endpoint that you don’t need.
- JWT request_uri processing is enabled on the authorize endpoint. Defaults to
Allows enabling/disabling various sections of the discovery document, e.g. endpoints, scopes, claims, grant types etc.
CustomEntries dictionary allows adding custom elements to the discovery document.
- Sets the cookie authentication scheme configured by the host used for interactive users. If not set, the scheme will be inferred from the host’s default authentication scheme. This setting is typically used when AddPolicyScheme is used in the host as the default scheme.
- The authentication cookie lifetime (only effective if the IdentityServer-provided cookie handler is used).
- Specifies if the cookie should be sliding or not (only effective if the IdentityServer-provided cookie handler is used).
- Specifies the SameSite mode for the internal cookies.
- Indicates if user must be authenticated to accept parameters to end session endpoint. Defaults to false.
- The name of the cookie used for the check session endpoint.
- If set, will require frame-src CSP headers being emitting on the end session callback endpoint which renders iframes to clients for front-channel signout notification. Defaults to true.
Allows configuring if and which events should be submitted to a registered event sink. See here for more information on events.
Allows setting length restrictions on various protocol parameters like client id, scope, redirect URI etc.
- Sets the URLs for the login, logout, consent, error and device verification pages.
- Sets the name of the return URL parameter passed to the login page. Defaults to returnUrl.
- Sets the name of the logout message id parameter passed to the logout page. Defaults to logoutId.
- Sets the name of the return URL parameter passed to the consent page. Defaults to returnUrl.
- Sets the name of the error message id parameter passed to the error page. Defaults to errorId.
- Sets the name of the return URL parameter passed to a custom redirect from the authorization endpoint. Defaults to returnUrl.
- Sets the name of the user code parameter passed to the device verification page. Defaults to userCode.
- Certain interactions between IdentityServer and some UI pages require a cookie to pass state and context (any of the pages above that have a configurable “message id” parameter). Since browsers have limits on the number of cookies and their size, this setting is used to prevent too many cookies being created. The value sets the maximum number of message cookies of any type that will be created. The oldest message cookies will be purged once the limit has been reached. This effectively indicates how many tabs can be opened by a user when using IdentityServer.
These settings only apply if the respective caching has been enabled in the services configuration in startup.
- Cache duration of client configuration loaded from the client store.
- Cache duration of identity and API resource configuration loaded from the resource store.
IdentityServer supports CORS for some of its endpoints. The underlying CORS implementation is provided from ASP.NET Core, and as such it is automatically registered in the dependency injection system.
- Name of the CORS policy that will be evaluated for CORS requests into IdentityServer (defaults to
"IdentityServer4"). The policy provider that handles this is implemented in terms of the
ICorsPolicyServiceregistered in the dependency injection system. If you wish to customize the set of CORS origins allowed to connect, then it is recommended that you provide a custom implementation of
- The endpoints within IdentityServer where CORS is supported. Defaults to the discovery, user info, token, and revocation endpoints.
- Nullable<TimeSpan> indicating the value to be used in the preflight Access-Control-Max-Age response header. Defaults to null indicating no caching header is set on the response.
CSP (Content Security Policy)¶
IdentityServer emits CSP headers for some responses, where appropriate.
- The level of CSP to use. CSP Level 2 is used by default, but if older browsers must be supported then this be changed to
CspLevel.Oneto accomodate them.
- Indicates if the older
X-Content-Security-PolicyCSP header should also be emitted (in addition to the standards-based header value). Defaults to true.
- The user code type to use, unless set at the client level. Defaults to Numeric, a 9-digit code.
- Defines the minimum allowed polling interval on the token endpoint. Defaults to 5.
- Specifies if MTLS support should be enabled. Defaults to
- Specifies the name of the authentication handler for X.509 client certificates. Defaults to
- Specifies either the name of the sub-domain or full domain for running the MTLS endpoints (will use path-based endpoints if not set).
Use a simple string (e.g. “mtls”) to set a sub-domain, use a full domain name (e.g. “identityserver-mtls.io”) to set a full domain name.
When a full domain name is used, you also need to set the
IssuerNameto a fixed value.
- Specifies whether a cnf claim gets emitted for access tokens if a client certificate was present. Normally the cnf claims only gets emitted if the client used the client certificate for authentication, setting this to true, will set the claim regardless of the authentication method. (defaults to false).