@octokit/plugin-enterprise-cloud
v13.0.0
Published
Octokit plugin for GitHubâs Enterprise Cloud REST APIs
Downloads
1,118
Readme
plugin-enterprise-cloud.js
Octokit plugin for GitHub’s Enterprise Cloud REST APIs
@octokit/rest
does not include endpoint methods for Enterprise Cloud, because it is available only to organizations on GitHub Enterprise Cloud. Learn more about About enterprise accounts.
Usage
Load @octokit/plugin-enterprise-cloud
and @octokit/core
(or core-compatible module) directly from esm.sh
<script type="module">
import { Octokit } from "https://esm.sh/@octokit/core";
import { enterpriseCloud } from "https://esm.sh/@octokit/plugin-enterprise-cloud";
</script>
Install with npm install @octokit/core @octokit/plugin-enterprise-cloud
. Optionally replace @octokit/core
with a core-compatible module
import { Octokit } from "@octokit/core";
import { enterpriseCloud } from "@octokit/plugin-enterprise-cloud";
const MyOctokit = Octokit.plugin(enterpriseCloud);
const octokit = new MyOctokit({ auth: "secret123" });
octokit.scim.listProvisionedIdentities({
filter: 'userName eq "Octocat"',
});
[!IMPORTANT] As we use conditional exports, you will need to adapt your
tsconfig.json
by setting"moduleResolution": "node16", "module": "node16"
.See the TypeScript docs on package.json "exports". See this helpful guide on transitioning to ESM from @sindresorhus
How it works
The GitHub Enterprise Cloud route definitions are build automatically from @octokit/routes
. Each time there is a new @octokit/routes
release, the .github/workflows/routes-update.yml
workflow is triggered. If an update to routes.json
is found, a pull request is created.