Bungie
OAuth 2.0 provider for Bungie. Only supports confidential clients.
Also see the OAuth 2.0 guide.
Initialization
import { Bungie } from "arctic";
const bungie = new Bungie(clientId, clientSecret, redirectURI);
Create authorization URL
import { generateState } from "arctic";
const state = generateState();
const scopes = ["ReadBasicUserProfile", "ReadGroups"];
const url = bungie.createAuthorizationURL(state, scopes);
Validate authorization code
validateAuthorizationCode()
will either return an OAuth2Tokens
, or throw one of OAuth2RequestError
, ArcticFetchError
, or a standard Error
(parse errors).
import { OAuth2RequestError, ArcticFetchError } from "arctic";
try {
const tokens = await bungie.validateAuthorizationCode(code);
const accessToken = tokens.accessToken();
} catch (e) {
if (e instanceof OAuth2RequestError) {
// Invalid authorization code, credentials, or redirect URI
const code = e.code;
// ...
}
if (e instanceof ArcticFetchError) {
// Failed to call `fetch()`
const cause = e.cause;
// ...
}
// Parse error
}
Refresh tokens are only provided for confidential clients.
const tokens = await bungie.validateAuthorizationCode(code);
const accessToken = tokens.accessToken();
const accessTokenExpiresAt = tokens.accessTokenExpiresAt();
const refreshToken = tokens.refreshToken();
The refresh token expiration is returned as refresh_expires_in
.
const tokens = await bungie.validateAuthorizationCode(code);
if ("refresh_expires_in" in tokens.data && typeof tokens.data.refresh_expires_in === "number") {
const refreshTokenExpiresIn = tokens.data.refresh_expires_in;
}
Refresh access tokens
Use refreshAccessToken()
to get a new access token using a refresh token. The behavior is identical to validateAuthorizationCode()
.
import { OAuth2RequestError, ArcticFetchError } from "arctic";
try {
const tokens = await bungie.refreshAccessToken(accessToken);
const accessToken = tokens.accessToken();
const accessTokenExpiresAt = tokens.accessTokenExpiresAt();
const refreshToken = tokens.refreshToken();
} catch (e) {
if (e instanceof OAuth2RequestError) {
// Invalid authorization code, credentials, or redirect URI
}
if (e instanceof ArcticFetchError) {
// Failed to call `fetch()`
}
// Parse error
}
Get user profile
Use the GetCurrentBungieNetUser
endpoint.
const response = await fetch("https://www.bungie.net/Platform/User/GetCurrentBungieNetUser", {
headers: {
Authorization: `Bearer ${accessToken}`,
"X-API-Key": apiKey
}
});
const emails = await response.json();