Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@octokit/auth-unauthenticated

Package Overview
Dependencies
Maintainers
4
Versions
23
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@octokit/auth-unauthenticated

GitHub API token authentication for browsers and Node.js

  • 6.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
679K
increased by0.92%
Maintainers
4
Weekly downloads
 
Created
Source

auth-unauthenticated.js

strategy for explicitly unauthenticated Octokit instances

@latest Build Status

@octokit/auth-unauthenticated is useful for cases when an Octokit constructor has a default authentication strategy, but you require an explicitly unauthenticated instance.

One use cases is when building a GitHub App using @octokit/auth-app and handling webhooks using @octokit/webhooks. While all webhook events provide an installation ID in its payload, in case of the installation.deleted event, the app can no longer create an installation access token, because the app's access has been revoked.

Usage

Browsers

Load @octokit/auth-unauthenticated directly from esm.sh

<script type="module">
  import { createUnauthenticatedAuth } from "https://esm.sh/@octokit/auth-unauthenticated";
</script>
Node

Install with npm install @octokit/auth-unauthenticated

import { createUnauthenticatedAuth } from "@octokit/auth-unauthenticated";
const auth = createUnauthenticatedAuth({
  reason:
    "Handling an installation.deleted event (The app's access has been revoked)",
});
const authentication = await auth();
// {
//   type: 'unauthenticated',
//   reason: 'Handling an installation.deleted event (The app's access has been revoked)'
// }

createUnauthenticatedAuth() options

The createUnauthenticatedAuth method requires an options.reason argument which will be used when returning an error due to a lack of authentication or when logging a warning in case of a 404 error.

Examples

createUnauthenticatedAuth({
  reason:
    "Handling an installation.deleted event: The app's access has been revoked from @octokit (id: 12345)",
});

auth()

The auth() method accepts any options, but it doesn't do anything with it. That makes it a great drop-in replacement for any other authentication strategy.

Authentication object

name type description
type string "unauthenticated"

auth.hook(request, route, options) or auth.hook(request, options)

auth.hook() hooks directly into the request life cycle. If a mutating request is attempted to be sent (DELETE, PATCH, POST, or PUT), the request is failed immediately and returning an error that contains the reason passed to createUnauthenticatedAuth({ reason }).

If a request fails with a 404 or due to hitting a rate/abuse limit, the returned error is amended that it might be caused due to a lack of authentication and will include the reason passed to createUnauthenticatedAuth({ reason }).

The request option is an instance of @octokit/request. The route/options parameters are the same as for the request() method.

auth.hook() can be called directly to send an authenticated request

const { data } = await auth.hook(request, "GET /");

Or it can be passed as option to request().

const requestWithAuth = request.defaults({
  request: {
    hook: auth.hook,
  },
});

const { data } = await requestWithAuth("GET /");

License

MIT

Keywords

FAQs

Package last updated on 03 Apr 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc