# atlassian-oauth-validator

> OAuth validator middleware that can be used to authenticate requests coming from an Atlassian app running plugins3.

Latest version **0.0.3** (published 2012-12-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install atlassian-oauth-validator
pnpm add atlassian-oauth-validator
yarn add atlassian-oauth-validator
bun add atlassian-oauth-validator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2012-12-12 |
| First published | 2012-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Andreas Knecht |
| Maintainers | andreask |
| Keywords | atlassian, oauth |

## Links

- npm: https://www.npmjs.com/package/atlassian-oauth-validator
- Repository: http://bitbucket.org/knecht_andreas/atlassian-oauth-validator
- npm.io page: https://npm.io/package/atlassian-oauth-validator

## Dependencies (1)

- [underscore](https://npm.io/package/underscore.md) 1.4.2

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2012-12-12
- 0.0.2 — 2012-12-03
- 0.0.1 — 2012-12-03

## README

# Atlassian OAuth Validator

The Atlassian OAuth Validator can be used as express js middleware for a Node JS application.  It serves the purpose
to authenticate incoming requests from an Atlassian Application to the Node JS application.

The flow would be as follows:

 * Startup Node JS application hosting a plugins 3 plugin xml file
 * Install the plugins 3 remotable plugin in your Atlassian application
 * If a webhook was registered in the atlassian-plugin.xml file the Atlassian App will call the Node JS app on this webhook with the Atlassian app's public key and additional information
 * The Node JS app should then persist this in a consumerStore (see the example/consumerStore.js implementation)
 * The Node JS app should then provide a UI to approve consumers in the consumer Store
 * Once approved the oauthValidator.js middleware can authenticate incoming requests with oauth parameters from the Atlassian app.

To use the middleware you need to register the following in your app configuration:

 ``app.use("/issue", oauthValidator(consumerStore));``

In this case only URLs under /issue will be protected. A consumerStore needs to be passed in which will be used to lookup
and approve consumers (see example/consumerStore.js for the API that this consumerStore needs to implement).

For a complete working example checkout: [https://bitbucket.org/knecht_andreas/nodejs-plugins3-server/](https://bitbucket.org/knecht_andreas/nodejs-plugins3-server/)

---
_Source: https://npm.io/package/atlassian-oauth-validator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._