1.3.1.1 OctoKit Token Authentication Strategy

• @octokit/auth-token.js

By default, Octokit authenticates using the ‘token’ authentication strategy.

• Pass in a token using options.auth

  import { Octokit } from "@octokit/core";
  
  const octokit = new Octokit({
    auth: "mypersonalaccesstoken123",
  });
  
  const { data } = await octokit.request("/user");
  

• It can be:
  • a personal access token
  • an OAuth token
  • an installation access token
  • a JSON Web Token for GitHub App authentication
• The ‘Authorization’ header will be set according to the type of token.

To use a different authentication strategy, set ‘options.authStrategy’

• A set of officially supported authentication strategies can be retrieved from @octokit/auth-app

  import { Octokit } from "@octokit/core";
  import { createAppAuth } from "@octokit/auth-app";
  
  const appOctokit = new Octokit({
    authStrategy: createAppAuth,
    auth: {
      appId: 123,
      privateKey: process.env.PRIVATE_KEY,
    },
  });
  
  const { data } = await appOctokit.request("/app");