| \n\nBrowsers\n\n | \n\n`@octokit/oauth-app` is not meant for browser usage.\n\n |
|---|---|
| \n\nNode\n\n | \n\nInstall with `npm install @octokit/oauth-app`\n\n |
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n clientId\n | \n \n number\n | \n \n Required. Find Client ID on the app’s about page in settings.\n | \n
\n clientSecret\n | \n \n number\n | \n \n Required. Find Client Secret on the app’s about page in settings.\n | \n
\n clientType\n | \n \n string\n | \n \n Either \"oauth-app\" or \"github-app\". Defaults to \"oauth-app\".\n | \n
\n allowSignup\n | \n \n boolean\n | \n \n Sets the default value for app.getWebFlowAuthorizationUrl(options).\n | \n
\n redirectUrl\n | \n \n string\n | \n \n The URL in your application where users will be sent after authorization. See Redirect URLs in GitHub’s Developer Guide.\n | \n
\n defaultScopes\n | \n \n Array of strings\n | \n \n\nOnly relevant when `clientType` is set to `\"oauth-app\"`.\n\nSets the default `scopes` value for `app.getWebFlowAuthorizationUrl(options)`. See [available scopes](https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes)\n\n |
\n log\n | \n \n object\n | \n \n Used for internal logging. Defaults to console.\n | \n
\n Octokit\n | \n \n Constructor\n | \n \n\nYou can pass in your own Octokit constructor with custom defaults and plugins. The Octokit Constructor must use an authentication strategy that is compatible with[`@octokit/auth-oauth-app](https://github.com/octokit/auth-oauth-app.js/#readme).\n\nFor usage with enterprise, set `baseUrl` to the hostname + `/api/v3`. Example:\n\n```js\nimport { Octokit } from \"@octokit/core\";\nnew OAuthApp({\n clientId: \"1234567890abcdef1234\",\n clientSecret: \"1234567890abcdef1234567890abcdef12345678\",\n Octokit: Octokit.defaults({\n baseUrl: \"https://ghe.my-company.com/api/v3\",\n }),\n});\n```\n\nDefaults to `@octokit/oauth-app`'s own `Octokit` constructor which can be imported separately from `OAuthApp`. It's [`@octokit/core`](https://github.com/octokit/core.js) with the [`@octokit/auth-oauth-user`](https://github.com/octokit/auth-oauth-user.js/#readme) authentication strategy.\n\n |
| \n property\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n context.name\n | \n \n string\n | \n \n Name of the event. One of: token, authorization\n | \n
\n context.action\n | \n \n string\n | \n \n Action of the event. One of: created, reset, deleted\n | \n
\n context.authentication\n | \n \n object\n | \n \n\nThe OAuth authentication object. See https://github.com/octokit/auth-oauth-user.js/#authentication-object\n\n | \n
\n context.octokit\n | \n \n Octokit instance\n | \n \n\nAuthenticated instance using the `Octokit` option passed to the constructor and [`@octokit/auth-oauth-user`](https://github.com/octokit/auth-oauth-user.js/#readme) as authentication strategy.\n\nThe `octokit` instance is unauthenticated for `\"token.deleted\"` and `\"authorization.deleted\"` events.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n redirectUrl\n | \n \n string\n | \n \n The URL in your application where users will be sent after authorization. See Redirect URLs in GitHub’s Developer Guide.\n | \n
\n login\n | \n \n string\n | \n \n Suggests a specific account to use for signing in and authorizing the app.\n | \n
\n scopes\n | \n \n array of strings\n | \n \n 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.\n | \n
\n state\n | \n \n string\n | \n \n An unguessable random string. It is used to protect against cross-site request forgery attacks.\n Defaults to Math.random().toString(36).substr(2).\n | \n
\n allowSignup\n | \n \n boolean\n | \n \n Whether or not unauthenticated users will be offered an option to sign up for GitHub during the OAuth flow. The default is true. Use false in the case that a policy prohibits signups.\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n code\n | \n \n string\n | \n \n Required. Pass the code that was passed as ?code query parameter in the authorization redirect URL.\n | \n
\n state\n | \n \n string\n | \n \n Required. Pass the state that was passed as ?state query parameter in the authorization redirect URL.\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n onVerification\n | \n \n function\n | \n \n\n**Required**. A function that is called once the device and user codes were retrieved\n\nThe `onVerification()` callback can be used to pause until the user completes step 2, which might result in a better user experience.\n\n```js\nconst auth = createOAuthUserAuth({\n clientId: \"1234567890abcdef1234\",\n clientSecret: \"1234567890abcdef1234567890abcdef12345678\",\n onVerification(verification) {\n console.log(\"Open %s\", verification.verification_uri);\n console.log(\"Enter code: %s\", verification.user_code);\n\n await prompt(\"press enter when you are ready to continue\");\n },\n});\n```\n\n | \n
\n scopes\n | \n \n array of strings\n | \n \n\nOnly relevant if `app.type` is `\"oauth-app\"`. Scopes are not supported by GitHub apps.\n\nArray of OAuth scope names that the user access token should be granted. Defaults to no scopes (`[]`).\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n token\n | \n \n string\n | \n \n Required.\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n token\n | \n \n string\n | \n \n Required.\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n refreshToken\n | \n \n string\n | \n \n Required.\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n target\n | \n \n string\n | \n \n Required unless targetId is set. The name of the user or organization to scope the user-to-server access token to.\n | \n
\n targetId\n | \n \n integer\n | \n \n Required unless target is set. The ID of the user or organization to scope the user-to-server access token to.\n | \n
\n repositories\n | \n \n array of strings\n | \n \n The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.\n | \n
\n repository_ids\n | \n \n array of integers\n | \n \n The list of repository IDs to scope the user-to-server access token to. repositories may not be specified if repositories is specified.\n | \n
\n permissions\n | \n \n object\n | \n \n The permissions granted to the user-to-server access token. See GitHub App Permissions.\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n token\n | \n \n string\n | \n \n Required.\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n token\n | \n \n string\n | \n \n Required.\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n app\n | \n \n OAuthApp instance\n | \n \n Required.\n | \n
\n options.pathPrefix\n | \n \n string\n | \n \n\nAll exposed paths will be prefixed with the provided prefix. Defaults to `\"/api/github/oauth\"`\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n app\n | \n \n OAuthApp instance\n | \n \n Required.\n | \n
\n options.pathPrefix\n | \n \n string\n | \n \n\nAll exposed paths will be prefixed with the provided prefix. Defaults to `\"/api/github/oauth\"`\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n app\n | \n \n OAuthApp instance\n | \n \n Required.\n | \n
\n options.pathPrefix\n | \n \n string\n | \n \n\nAll exposed paths will be prefixed with the provided prefix. Defaults to `\"/api/github/oauth\"`\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n app\n | \n \n OAuthApp instance\n | \n \n Required.\n | \n
\n options.pathPrefix\n | \n \n string\n | \n \n\nAll exposed paths will be prefixed with the provided prefix. Defaults to `\"/api/github/oauth\"`\n\n | \n
\n request\n | \n \n OctokitRequest\n | \n \n Generalized HTTP request in `OctokitRequest` type.\n | \n