@octokit/plugin-scim

Octokit plugin for GitHub’s SCIM API

Usage no npm install needed!

<script type="module">
  import octokitPluginScim from 'https://cdn.skypack.dev/@octokit/plugin-scim';
</script>

README

plugin-scim.js

Octokit plugin for GitHub’s SCIM API

Build Status Coverage Status Greenkeeper badge

@octokit/rest does not include endpoint methods for the SCIM API, because it is available only to organizations on GitHub Business Cloud. See also the GitHub REST SCIM API documentation.

Usage

const Octokit = require('@octokit/rest')
  .plugin(require('@octokit/scim-routes'))
const octokit = new Octokit()

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

How it works

The SCIM route definitions are build automatically from @octokit/routes. Each time there is a new @octokit/routes release, Greenkeeper will send a pull request which updates the dependency in package.json and package-lock.json. That kicks of a build on Travis CI where the greenkeeper-routes-update script is run. If there is a change, the script updates the routes.json file in the pull request.

LICENSE

MIT