github-apps-helper

:sleeping: Insomnia template tags for interacting with GitHub APIs using GitHub Apps

Provides custom template tags to generate JWTs (JSON Web Tokens) and installation access tokens, easing GitHub App authentication when working with GitHub APIs within Insomnia.

Features

1. JWT (JSON Web Token) generation, for authenticating as a GitHub App
2. Installation access token generation, for authentication as a GitHub App installation
3. Caching, and automatic regeneration, of installation access tokens
4. Environment-wide configuration, that can be overridden per-request, to ease setup

Installation

Install insomnia-plugin-github-apps-helper from the Plugins tab within Insomnia's application preferences dialog:

Configuration

Set the following environment variables within Insomnia:

1. github_app_id: The ID for your GitHub App
   • This is available from the settings page of your GitHub App, as App ID.
2. github_app_private_key_path: The path on your machine to a private key for your GitHub App, e.g. /path/to/your-app.YYYY-MM-DD.private-key.pem
   • More information on generating and downloading private keys for your GitHub Apps is available in the documentation
3. github_app_installation_id: The ID for an installation of your GitHub App
   • Found using the GET /app/installations API endpoint
4. github_api_root: The API Root for your GitHub App

Usage

Two template tags are provided by this plugin:

1. jwt: Generates a JSON Web Token, allowing you to authenticate with the GitHub API as your GitHub App
2. installation_access_token: Generates an Installation Access Token, allowing you to authenticate with the GitHub API as an installation of your GitHub App

jwt

Generates a JSON Web Token, allowing you to authenticate with the GitHub API as your GitHub App.

Usage

Create a new request, e.g. GET /app:

Set the appropriate URL for your request, and configure auth to Bearer Token:

Use auto-complete to select the JSON Web Token tag:

Hit Send. You're good to go :rocket:

installation_access_token

Generates an Installation Access Token, allowing you to authenticate with the GitHub API as an installation of your GitHub App.

Usage

Create a new request, e.g. GET /installation/repositories:

Set the appropriate URL for your request, and configure auth to Bearer Token:

Use auto-complete to select the Installation Access Token tag:

Hit Send. You're good to go :rocket:

Feedback

Please open an issue.