| Browsers | Load `@octokit/auth-basic` directly from [cdn.skypack.dev](https://cdn.skypack.dev) ```html ``` |
|---|---|
| Node |
Install with npm install @octokit/auth-basic
```js
const { createBasicAuth } = require("@octokit/auth-basic");
// or: import { createBasicAuth } from "@octokit/auth-basic";
```
|
| name | type | description |
|---|---|---|
username
|
string
|
Required. Username of the account to login with. |
password
|
string
|
Required. Password of the account to login with. |
on2Fa
|
function
|
Required. If the user has two-factor authentication (2FA) enabled, the on2Fa method will be called and expected to return a time-based one-time password (TOTP) which the user retrieves either via SMS or an authenticator app, based on their account settings. You can pass an empty function if you are certain the account has 2FA disabled.Alias: on2fa
|
token
|
object
|
An object matching "Create a new authorization" parameters, but camelCased. |
token.note
|
string
|
A note to remind you what the OAuth token is for. Personal access tokens must have a unique note. Attempting to create a token with with an existing note results in a 409 conflict error.Defaults to "octokit <timestamp> <fingerprint>", where <timestamp> has the format YYYY-MM-DD and <fingerprint> is a random string. Example: "octokit 2019-04-03 abc4567".
|
token.scopes
|
array of strings
|
A list of scopes that this authorization is in. See available scopes Defaults to an empty array |
token.noteUrl
|
string
|
A URL to remind you what app the OAuth token is for. Defaults to "https://github.com/octokit/auth-basic.js#readme" |
token.fingerprint
|
string
|
A unique string to distinguish an authorization from others created for the same client ID and user. Defaults to a random string |
token.clientId
|
string
|
The 20 character OAuth app client key for which to create the token. |
token.clientSecret
|
string
|
The 40 character OAuth app client secret for which to create the token. Note: do not share an OAuth app’s client secret with an untrusted client such as a website or native app. |
request
|
function
|
You can pass in your own @octokit/request instance. For usage with enterprise, set baseUrl to the hostname + /api/v3. Example:
```js
const { request } = require("@octokit/request");
createAppAuth({
clientId: 123,
clientSecret: "secret",
request: request.defaults({
baseUrl: "https://ghe.my-company.com/api/v3",
}),
});
```
|
| name | type | description |
|---|---|---|
type
|
string
|
Either "basic" or "token". Defaults to "token".
|
refresh
|
boolean
|
If set to true, a new token is created and cached. Only relevent if type is set to "token".
Defaults to false.
|
| name | type | description |
|---|---|---|
type
|
string
|
"token"
|
tokenType
|
string
|
"pat"
|
token
|
string
|
The personal access token |
id
|
number
|
Database ID of token |
username
|
string
|
Username of authenticated user |
scopes
|
array of strings
|
array of scope names |
| name | type | description |
|---|---|---|
type
|
string
|
"token"
|
tokenType
|
string
|
"oauth"
|
token
|
string
|
The oauth access token |
username
|
string
|
Username of authenticated user |
id
|
number
|
Database ID of token |
appClientId
|
number
|
OAuth application’s client ID |
scopes
|
array of strings
|
array of scope names |
| name | type | description |
|---|---|---|
type
|
string
|
"basic"
|
username
|
string
|
The decoded username |
password
|
string
|
The decoded password |
credentials
|
string
|
base64-encoded string that can be used in Authorization header.
|
totp
|
string
|
The time-based one-time password returned by options.on2Fa(). Only present if 2Fa authentication is enabled for the account.
|