Atlassian OAuth 2.0 (3LO)
Authorization Code Exchange for web and mobile — Atlassian OAuth 2.0 (3LO) setup, API reference, and frontend examples.
Overview
Atlassian login is optional and controlled by ATLASSIAN_AUTH_ENABLED. When disabled, Atlassian endpoints return 503 Service Unavailable. JWTs are never placed in the redirect URL; the API issues a one-time exchangeCode (Redis, 60 seconds). The same POST /auth/exchange endpoint is shared with other social providers.
- • Feature-flagged via environment
- • Custom passport-oauth2 strategy + AtlassianAuthGuard
- • Profile fetched via GET https://api.atlassian.com/me after token exchange
- • Authorize params include audience=api.atlassian.com and prompt=consent
- • Redirect allowlist prevents open redirects
- • Same token response shape as POST /auth/login
Atlassian Developer Console
Create an app at https://developer.atlassian.com/console/myapps/ → Create → OAuth 2.0 (3LO). Set the Callback URL to match ATLASSIAN_CALLBACK_URL. Add the User Identity API and scope read:me.
- Open https://developer.atlassian.com/console/myapps/ and click Create → OAuth 2.0 (3LO)
- Set the Callback URL (e.g. http://localhost:3000/api/v1/auth/atlassian/callback)
- Add the User Identity API and scope read:me
- Copy Client ID and Client Secret into your .env
- Ensure ATLASSIAN_CALLBACK_URL matches the Callback URL registered in the Atlassian console
Environment variables
Loaded from .env via src/config/atlassian-oauth.config.ts (namespace atlassianOAuth on ConfigService). See .env.example.
ATLASSIAN_AUTH_ENABLED=true ATLASSIAN_CLIENT_ID=your-atlassian-client-id ATLASSIAN_CLIENT_SECRET=your-atlassian-client-secret ATLASSIAN_CALLBACK_URL=http://localhost:3000/api/v1/auth/atlassian/callback ATLASSIAN_REDIRECT_ALLOWLIST=myapp://success,http://localhost:5173/auth/callback ATLASSIAN_OAUTH_DEFAULT_ROLES=
Default roles for new Atlassian users
New Atlassian users receive roles: [] by default (same as password register). Set ATLASSIAN_OAUTH_DEFAULT_ROLES in .env to a comma-separated list of Role values (e.g. user or user,manager). Existing users linked by email keep their current roles.
Sequence
- Client opens GET /api/v1/auth/atlassian?redirect=<allowlisted URL>
- User consents on Atlassian; browser hits GET /api/v1/auth/atlassian/callback
- API calls GET https://api.atlassian.com/me, upserts user, stores exchangeCode in Redis, redirects to redirect?code=...
- Client POSTs { code } to /api/v1/auth/exchange and receives JWTs
API reference
1. Start OAuth
Opens Atlassian consent at https://auth.atlassian.com/authorize with audience=api.atlassian.com and prompt=consent. Query redirect must match a prefix in ATLASSIAN_REDIRECT_ALLOWLIST (or omit to use the first allowlist entry). Scope: read:me.
GET /api/v1/auth/atlassian?redirect=http%3A%2F%2Flocalhost%3A5173%2Fauth%2Fcallback
400 invalid redirect · 503 feature disabled
2. Callback
Handled by the API. Token exchange uses https://auth.atlassian.com/oauth/token. Redirects to your app with ?code= (or &code= if the URL already has a query).
GET /api/v1/auth/atlassian/callback?code=ATLASSIAN_AUTH_CODE&state=... → 302 Location: http://localhost:5173/auth/callback?code=EXCHANGE_CODE
3. Exchange code
Public endpoint shared with other social providers. Consumes the code (single use) and returns the same shape as login.
POST /api/v1/auth/exchange
Content-Type: application/json
{
"code": "EXCHANGE_CODE"
}{
"user": {
"id": "...",
"email": "[email protected]",
"firstName": "Jane",
"lastName": "Doe",
"roles": [],
"atlassianId": "712020:abc123",
"isActive": true
},
"accessToken": "eyJhbGciOiJIUzI1NiIs...",
"refreshToken": "eyJhbGciOiJIUzI1NiIs..."
}401 invalid/expired/used code · 503 social auth disabled
Frontend — Web (SPA)
Typical flow: button starts OAuth in the same window (or popup); a callback route on your frontend origin reads code from the query string and calls exchange.
const API = 'http://localhost:3000/api/v1';
const redirect = encodeURIComponent(
'http://localhost:5173/auth/callback'
);
// Full-page redirect to Nest → Atlassian → back to SPA
window.location.href = `${API}/auth/atlassian?redirect=${redirect}`;// /auth/callback on the SPA
const params = new URLSearchParams(window.location.search);
const code = params.get('code');
if (!code) throw new Error('Missing exchange code');
const res = await fetch('http://localhost:3000/api/v1/auth/exchange', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ code }),
});
if (!res.ok) throw new Error(await res.text());
const { user, accessToken, refreshToken } = await res.json();
// persist tokens as your app requires
sessionStorage.setItem('accessToken', accessToken);
console.log('signed in', user.email);- • Add your frontend callback URL to ATLASSIAN_REDIRECT_ALLOWLIST (e.g. http://localhost:5173/auth/callback)
- • ATLASSIAN_CALLBACK_URL must point at the Nest API, not the SPA
- • Store accessToken / refreshToken securely (memory + httpOnly cookie patterns as you prefer)
Frontend — Mobile (deep link)
Use a custom scheme (or universal link) in the allowlist. After Atlassian, the API redirects to myapp://success?code=.... The app opens, parses the code, and calls exchange.
import * as Linking from 'expo-linking';
import * as WebBrowser from 'expo-web-browser';
const API = 'https://api.example.com/api/v1';
const redirect = encodeURIComponent('myapp://success');
async function signInWithAtlassian() {
const url = `${API}/auth/atlassian?redirect=${redirect}`;
await WebBrowser.openAuthSessionAsync(url, 'myapp://success');
}import * as Linking from 'expo-linking';
async function exchangeFromUrl(url) {
const { queryParams } = Linking.parse(url);
const code = queryParams?.code;
if (!code) return;
const res = await fetch(`${API}/auth/exchange`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ code }),
});
const data = await res.json();
// data.accessToken, data.refreshToken, data.user
return data;
}
Linking.addEventListener('url', ({ url }) => {
exchangeFromUrl(url);
});- • Register the scheme in the OS / Expo app.json
- • Prefer Linking.addEventListener('url', ...) and getInitialURL()
- • Exchange over HTTPS against your API base URL
Security notes
- • Redirect URLs must match ATLASSIAN_REDIRECT_ALLOWLIST prefixes
- • Exchange codes are single-use and expire in 60 seconds (Redis)
- • Existing local users are linked by verified Atlassian email (atlassianId set; roles unchanged)
- • Atlassian-only users have password null — password login / change-password will fail until a password is set
- • Email is required from api.atlassian.com/me; login fails if Atlassian does not return an email (scope read:me)
User model
Postgres entity / interface fields used by Atlassian login:
- • atlassianId — unique nullable Atlassian account id (account_id from /me)
- • password — nullable for OAuth-only accounts
- • isActive — set true for new Atlassian users
- • roles — from ATLASSIAN_OAUTH_DEFAULT_ROLES env (default [])
Related
- Social Authentication hub
- Google OAuth2 guide
- Facebook OAuth2 guide
- X / Twitter OAuth2 guide
- GitHub OAuth2 guide
- Figma OAuth2 guide
- LinkedIn OpenID Connect guide
- Slack OpenID Connect guide
- GitLab OAuth2 guide
- Bitbucket OAuth2 guide
- Discord OAuth2 guide
- Twitch OAuth2 guide
- Steam OpenID 2.0 guide
- Reddit OAuth2 guide
- Auth & JWT