Skip to content
Octokit plugin for GitHub Enterprise Cloud REST APIs
TypeScript JavaScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
scripts/update-endpoints
src
test
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
package-lock.json
package.json
tsconfig.json

README.md

plugin-enterprise-cloud.js

Octokit plugin for GitHub’s Enterprise Cloud REST APIs

@latest Build Status

@octokit/rest does not include endpoint methods for Enterprise Cloud, because it is available only to organizations on GitHub Business Cloud. Learn more about About enterprise accounts.

Usage

Browsers

Load @octokit/plugin-enterprise-cloud and @octokit/core (or core-compatible module) directly from cdn.pika.dev

<script type="module">
  import { Octokit } from "https://cdn.pika.dev/@octokit/core";
  import { enterpriseCloud } from "https://cdn.pika.dev/@octokit/plugin-enterprise-cloud";
</script>
Node

Install with npm install @octokit/core @octokit/plugin-enterprise-cloud. Optionally replace @octokit/core with a core-compatible module

const { Octokit } = require("@octokit/core");
const { enterpriseCloud } = require("@octokit/plugin-enterprise-cloud");
const MyOctokit = Octokit.plugin(enterpriseCloud);
const octokit = new MyOctokit({ auth: "secret123" });

octokit.scim.listProvisionedIdentities({
  filter: 'userName eq "Octocat"',
});

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.

LICENSE

MIT

You can’t perform that action at this time.