{"id":15654447,"url":"https://github.com/swinton/insomnia-plugin-github-apps-helper","last_synced_at":"2025-04-30T23:48:04.782Z","repository":{"id":31467122,"uuid":"127358048","full_name":"swinton/insomnia-plugin-github-apps-helper","owner":"swinton","description":"😴 Insomnia template tags for interacting with GitHub APIs using GitHub Apps","archived":false,"fork":false,"pushed_at":"2023-01-09T17:04:43.000Z","size":958,"stargazers_count":26,"open_issues_count":16,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-30T23:47:59.024Z","etag":null,"topics":["github-apps","insomnia-plugin"],"latest_commit_sha":null,"homepage":"https://npm.im/insomnia-plugin-github-apps-helper","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swinton.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-29T23:33:57.000Z","updated_at":"2024-06-24T14:47:38.000Z","dependencies_parsed_at":"2023-01-14T19:06:25.932Z","dependency_job_id":null,"html_url":"https://github.com/swinton/insomnia-plugin-github-apps-helper","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swinton%2Finsomnia-plugin-github-apps-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swinton%2Finsomnia-plugin-github-apps-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swinton%2Finsomnia-plugin-github-apps-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swinton%2Finsomnia-plugin-github-apps-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swinton","download_url":"https://codeload.github.com/swinton/insomnia-plugin-github-apps-helper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251801086,"owners_count":21645968,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-apps","insomnia-plugin"],"created_at":"2024-10-03T12:51:50.643Z","updated_at":"2025-04-30T23:48:04.761Z","avatar_url":"https://github.com/swinton.png","language":"JavaScript","readme":"# `github-apps-helper` ![](https://github.com/swinton/insomnia-plugin-github-apps-helper/workflows/tests/badge.svg)\n\n\u003e :sleeping: **Insomnia** [template tags](https://support.insomnia.rest/article/40-template-tags) for interacting with GitHub APIs using **[GitHub Apps](https://developer.github.com/apps/)**\n\nProvides custom template tags to generate JWTs (JSON Web Tokens) and _installation access tokens_, easing GitHub App authentication when working with GitHub APIs within Insomnia.\n\n## Features\n\n1. JWT (JSON Web Token) generation, for [authenticating as a GitHub App](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)\n1. Installation access token generation, for [authentication as a GitHub App installation](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)\n1. Caching, and automatic regeneration, of installation access tokens\n1. Environment-wide configuration, that can be overridden per-request, to ease setup\n\n## Installation\n\nInstall **\u003ckbd\u003einsomnia-plugin-github-apps-helper\u003c/kbd\u003e** from the Plugins tab within Insomnia's application preferences dialog:\n\n![installation](https://user-images.githubusercontent.com/27806/53279590-57c66880-36d7-11e9-8207-2b68a0778961.gif)\n\n## Configuration\n\nSet the following [environment variables within Insomnia](https://support.insomnia.rest/article/18-environment-variables):\n\n1. \u003ckbd\u003egithub_app_id\u003c/kbd\u003e: The ID for your GitHub App\n    - This is available from the settings page of your GitHub App, as `App ID`.\n1. \u003ckbd\u003egithub_app_private_key_path\u003c/kbd\u003e: 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`\n    - More information on generating and downloading private keys for your GitHub Apps is [available in the documentation](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#generating-a-private-key)\n1. \u003ckbd\u003egithub_app_installation_id\u003c/kbd\u003e: The ID for an installation of your GitHub App\n    - Found using [the `GET /app/installations`](https://developer.github.com/v3/apps/#find-installations) API endpoint\n1. \u003ckbd\u003egithub_api_root\u003c/kbd\u003e: The API Root for your GitHub App\n\n## Usage\n\nTwo template tags are provided by this plugin:\n\n1. **[`jwt`](#jwt)**: Generates a JSON Web Token, allowing you to authenticate with the GitHub API as your GitHub App\n1. **[`installation_access_token`](#installation_access_token)**: Generates an Installation Access Token, allowing you to authenticate with the GitHub API as an installation of your GitHub App\n\n### `jwt`\n\nGenerates a JSON Web Token, allowing you to [authenticate with the GitHub API as your GitHub App](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps/#authenticating-as-a-github-app).\n\n**Usage**\n\nCreate a new request, e.g. `GET /app`:\n\n\u003cimg width=\"791\" alt=\"screen shot 2019-02-22 at 7 29 33 pm\" src=\"https://user-images.githubusercontent.com/27806/53279699-7f6a0080-36d8-11e9-91e6-87b890743e46.png\"\u003e\n\nSet [the appropriate URL for your request](https://developer.github.com/v3/apps/#get-a-single-github-app), and configure auth to `Bearer Token`:\n\n\u003cimg width=\"604\" alt=\"screen shot 2019-02-22 at 7 30 08 pm\" src=\"https://user-images.githubusercontent.com/27806/53279701-81cc5a80-36d8-11e9-8f6e-b67e0f3b66ad.png\"\u003e\n\nUse auto-complete to select the `JSON Web Token` tag:\n\n\u003cimg width=\"600\" alt=\"screen shot 2019-02-22 at 7 30 27 pm\" src=\"https://user-images.githubusercontent.com/27806/53279704-842eb480-36d8-11e9-9cef-9b7ac9bf0e51.png\"\u003e\n\nHit `Send`. You're good to go :rocket:\n\n### `installation_access_token`\n\nGenerates an Installation Access Token, allowing you to [authenticate with the GitHub API as an installation of your GitHub App](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation).\n\n**Usage**\n\nCreate a new request, e.g. `GET /installation/repositories`:\n\n\u003cimg width=\"784\" alt=\"screen shot 2019-02-22 at 7 06 06 pm\" src=\"https://user-images.githubusercontent.com/27806/53279319-06b57500-36d5-11e9-97f1-c772ae0e6112.png\"\u003e\n\nSet [the appropriate URL for your request](https://developer.github.com/v3/apps/installations/#list-repositories), and configure auth to `Bearer Token`:\n\n![installation-repositories-bearer-token-higlight-option](https://user-images.githubusercontent.com/27806/54845300-0514a800-4ca7-11e9-8801-2735ca5039dc.png)\n\nUse auto-complete to select the `Installation Access Token` tag:\n\n\u003cimg width=\"550\" alt=\"screen shot 2019-02-22 at 7 10 12 pm\" src=\"https://user-images.githubusercontent.com/27806/53279383-82afbd00-36d5-11e9-9ddb-c8c1a9e5b93f.png\"\u003e\n\nHit `Send`. You're good to go :rocket:\n\n## Feedback\n\nPlease [open an issue](/swinton/insomnia-plugin-github-apps-helper/issues/new).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswinton%2Finsomnia-plugin-github-apps-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswinton%2Finsomnia-plugin-github-apps-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswinton%2Finsomnia-plugin-github-apps-helper/lists"}