| \n\nBrowsers\n\n | \n\nLoad `@octokit/auth-oauth-device` directly from [esm.sh](https://esm.sh)\n\n```html\n\n```\n\n |
|---|---|
| \n\nNode\n\n | \n\nInstall with `npm install @octokit/core @octokit/auth-oauth-device`\n\n```js\nimport { createOAuthDeviceAuth } from \"@octokit/auth-oauth-device\";\n```\n\n |
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n clientId\n | \n \n string\n | \n \n Required. Find your OAuth app’s Client ID in your account’s developer settings.\n | \n
\n onVerification\n | \n \n function\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 = createOAuthDeviceAuth({\n clientId: \"1234567890abcdef1234\",\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 clientType\n | \n \n string\n | \n \n\nMust be either `oauth-app` or `github-app`. Defaults to `oauth-app`.\n\n | \n
\n request\n | \n \n function\n | \n \n You can pass in your own @octokit/request instance. For usage with enterprise, set baseUrl to the API root endpoint. Example:\n\n```js\nimport { request } from \"@octokit/request\";\ncreateOAuthDeviceAuth({\n clientId: \"1234567890abcdef1234\",\n clientSecret: \"secret\",\n request: request.defaults({\n baseUrl: \"https://ghe.my-company.com/api/v3\",\n }),\n});\n```\n\n |
\n scopes\n | \n \n array of strings\n | \n \n\nOnly relevant if `clientType` is set to `\"oauth-app\"`.\n\nArray of scope names enabled for the token. Defaults to `[]`. See [available scopes](https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes).\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n type\n | \n \n string\n | \n \n Required. Must be set to \"oauth\"\n | \n
\n scopes\n | \n \n array of strings\n | \n \n\nOnly relevant if the `clientType` strategy options was set to `\"oauth-app\"`\n\nArray of scope names enabled for the token. Defaults to what was set in the [strategy options](#createoauthdeviceauthoptions). See available scopes\n\n | \n
\n refresh\n | \n \n boolean\n | \n \n\nDefaults to `false`. When set to `false`, calling `auth(options)` will resolve with a token that was previously created for the same scopes if it exists. If set to `true` a new token will always be created.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n type\n | \n \n string\n | \n \n \"token\"\n | \n
\n tokenType\n | \n \n string\n | \n \n \"oauth\"\n | \n
\n clientType\n | \n \n string\n | \n \n \"github-app\"\n | \n
\n clientId\n | \n \n string\n | \n \n The app's Client ID\n | \n
\n token\n | \n \n string\n | \n \n The personal access token\n | \n
\n scopes\n | \n \n array of strings\n | \n \n array of scope names enabled for the token\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n type\n | \n \n string\n | \n \n \"token\"\n | \n
\n tokenType\n | \n \n string\n | \n \n \"oauth\"\n | \n
\n clientType\n | \n \n string\n | \n \n \"github-app\"\n | \n
\n clientId\n | \n \n string\n | \n \n The app's Client ID\n | \n
\n token\n | \n \n string\n | \n \n The personal access token\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n type\n | \n \n string\n | \n \n \"token\"\n | \n
\n tokenType\n | \n \n string\n | \n \n \"oauth\"\n | \n
\n clientType\n | \n \n string\n | \n \n \"github-app\"\n | \n
\n clientId\n | \n \n string\n | \n \n The app's Client ID\n | \n
\n token\n | \n \n string\n | \n \n The user access token\n | \n
\n refreshToken\n | \n \n string\n | \n \n The refresh token\n | \n
\n expiresAt\n | \n \n string\n | \n \n Date timestamp in ISO 8601 standard. Example: 2022-01-01T08:00:0.000Z\n | \n
\n refreshTokenExpiresAt\n | \n \n string\n | \n \n Date timestamp in ISO 8601 standard. Example: 2021-07-01T00:00:0.000Z\n | \n