Awesome
oauth-authorization-url.js
Universal library to retrieve GitHub’s identity URL for the OAuth web flow
See GitHub’s Developer Guide for the OAuth App web application flow. Note that the OAuth web application flow for GitHub Apps is slightly different. GitHub Apps do not support scopes for its user access tokens (they are called user-to-server tokens for GitHub Apps), instead they inherit the user permissions from the GitHub App's registration and the repository/organization access and permissions from the respective installation.
<!-- toc --> <!-- tocstop -->Usage
<table> <tbody valign=top align=left> <tr> <th> Browsers </th> <td width=100%>Load @octokit/oauth-authorization-url
directly from esm.sh
<script type="module">
import { oauthAuthorizationUrl } from "https://esm.sh/@octokit/oauth-authorization-url";
</script>
</td></tr>
<tr>
<th>
Node
</th>
<td>
Install with <code>npm install @octokit/oauth-authorization-url</code>
const { oauthAuthorizationUrl } = require("@octokit/oauth-authorization-url");
// or: import { oauthAuthorizationUrl } from "@octokit/oauth-authorization-url";
</td></tr>
</tbody>
</table>
[!IMPORTANT] As we use conditional exports, you will need to adapt your
tsconfig.json
by setting"moduleResolution": "node16", "module": "node16"
.See the TypeScript docs on package.json "exports".<br> See this helpful guide on transitioning to ESM from @sindresorhus
For OAuth Apps
const { url, clientId, redirectUrl, login, scopes, state } =
oauthAuthorizationUrl({
clientType: "oauth-app",
clientId: "1234567890abcdef1234",
redirectUrl: "https://example.com",
login: "octocat",
scopes: ["repo", "admin:org"],
state: "secret123",
});
For GitHub Apps
const { url, clientId, redirectUrl, login, state } = oauthAuthorizationUrl({
clientType: "github-app",
clientId: "lv1.1234567890abcdef",
redirectUrl: "https://example.com",
login: "octocat",
state: "secret123",
});
Options
<table> <thead align=left> <tr> <th width=200> name </th> <th> description </th> </tr> </thead> <tbody align=left valign=top> <tr> <th> <code>clientId</code> </th> <td> <strong>Required</strong>. The client ID you received from GitHub when you registered. </td> </tr> <tr> <th> <code>clientType</code> </th> <td>Must be set to either "oauth-app"
or "github-app"
. Defaults to "oauth-app"
.
Only relevant when clientType
is set to "oauth-app"
.
An array of scope names (or: space-delimited list of scopes). If not provided, scope defaults to an empty list for users that have not authorized any scopes for the application. For users who have authorized scopes for the application, the user won't be shown the OAuth authorization page with the list of scopes. Instead, this step of the flow will automatically complete with the set of scopes the user has authorized for the application. For example, if a user has already performed the web flow twice and has authorized one token with user scope and another token with repo scope, a third web flow that does not provide a scope will receive a token with user and repo scope.
Defaults to []
if clientType
is set to "oauth-app"
.
Result
oauthAuthorizationUrl()
returns an object with the following properties
Only set if options.clientType
is set to "oauth-app"
.
Returns an array of strings. Returns <code>options.scopes</code> if it was set and turns the string into an array if a string was passed, otherwise <code>[]</code>.
</td> </tr> <tr> <th> <code>state</code> </th> <td> Returns <code>options.state</code> if it was set. Defaults to Defaults to <code>Math.random().toString(36).substr(2)</code>. </td> </tr> <tr> <th> <code>url</code> </th> <td> The authorization URL </td> </tr> </tbody> </table>Types
import {
ClientType,
OAuthAppOptions,
OAuthAppResult,
GitHubAppOptions,
GitHubAppResult,
} from "@octokit/oauth-authorization-url";