express-openid-connect

(★ 517)

An Express.js middleware to protect OpenID Connect web applications.

File Explorer

Download Latest Version (.zip)

- - Bug Report.yml
  - config.yml
  - Feature Request.yml
- - claude-code-review.yml
  - codeql.yml
  - npm-release.yml
  - release.yml
  - rl-secure.yml
  - snyk.yml
  - test.yml
- CODEOWNERS
- dependabot.yml
- stale.yml
- - hierarchy.js
  - highlight.css
  - icons.js
  - icons.svg
  - main.js
  - navigation.js
  - search.js
  - style.css
- - MtlsError.html
  - SessionExpiredError.html
- - attemptSilentLogin.html
  - auth.html
  - claimCheck.html
  - claimEquals.html
  - claimIncludes.html
  - requiresAuth.html
- - AccessToken.html
  - ActClaim.html
  - AuthorizationParameters.html
  - BackchannelLogoutOptions.html
  - CallbackOptions.html
  - ConfigParams.html
  - CookieConfigParams.html
  - CustomTokenExchangeOptions.html
  - LoginOptions.html
  - LogoutOptions.html
  - OpenidRequest.html
  - OpenidResponse.html
  - RefreshParams.html
  - RequestContext.html
  - ResponseContext.html
  - Session.html
  - SessionConfigParams.html
  - SessionStore.html
  - SessionStorePayload.html
  - SessionTransferRedirectOptions.html
  - SessionTransferTokenOptions.html
  - SessionTransferTokenResult.html
  - TokenExchangeResponse.html
  - TokenParameters.html
- - IdTokenClaims.html
- - MtlsErrorCode.html
- .nojekyll
- hierarchy.html
- index.html
- - helpers.js
  - jwk.js
  - oidc-provider.js
- access-an-api.js
- attempt-silent-login.test.js
- backchannel-logout.test.js
- basic.test.js
- custom-token-exchange.test.js
- jar.test.js
- private-key-jwt.test.js
- userinfo.test.js
- .env.sample
- access-an-api.js
- api.js
- attempt-silent-login.js
- backchannel-logout-custom-genid.js
- backchannel-logout-custom-query-store.js
- backchannel-logout.js
- basic.js
- client-secret-jwt.js
- cte-session-transfer.js
- custom-routes.js
- custom-session-store.js
- custom-token-exchange.js
- iframe.js
- jar.js
- mtls.js
- passwordless.js
- private-key-jwt.js
- private-key.pem
- README.md
- routes.js
- run_example.js
- userinfo.js
- validate_claims.js
- - getLoginState.js
- - epoch.js
  - oidcError.js
  - promisifyCompat.js
  - sessionExpiry.js
- appSession.js
- client.js
- config.js
- context.js
- cookies.js
- crypto.js
- debug.js
- errors.js
- once.js
- tokenset.js
- transientHandler.js
- weakCache.js
- attemptSilentLogin.js
- auth.js
- requiresAuth.js
- unauthorizedHandler.js
- code-style.md
- commands.md
- docs-update.md
- git-workflow.md
- pitfalls.md
- testing.md
- - cert.js
  - server.js
  - sessionEncryption.js
  - store.js
  - well-known.json
- appSession.customStore.tests.js
- appSession.tests.js
- attemptSilentLogin.tests.js
- backchannelLogout.tests.js
- callback.tests.js
- client.tests.js
- config.tests.js
- crypto.tests.js
- customTokenExchange.tests.js
- login.tests.js
- logout.tests.js
- requiresAuth.tests.js
- sessionExpiry.tests.js
- sessionTransferToken.tests.js
- setup.js
- transientHandler.tests.js
.gitignore
.prettierignore
.prettierrc
.puppeteerrc.cjs
.semgrepignore
.shiprc
.version
AGENTS.md
ARCHITECTURE.md
CHANGELOG.md
CLAUDE.md
codecov.yml
CONTRIBUTING.md
eslint.config.js
EXAMPLES.md
FAQ.md
index.d.ts
index.js
index.test-d.ts
LICENSE
login.png
logout.png
opslevel.yml
package.json
README.md
TROUBLESHOOTING.md
tsconfig.json
typedoc.js
V2_MIGRATION_GUIDE.md
V3_MIGRATION_GUIDE.md

# Installation Guide

1. Get the code

git clone https://github.com/auth0/express-openid-connect

Downloads the entire project code from GitHub to your computer.

cd express-openid-connect

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install express-openid-connect

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.