FredHutch/github-on-and-off-boarding

Name: github-on-and-off-boarding

Owner: Fred Hutchinson Cancer Research Center

Description: Manage addition/removal of users from Github orgs/teams with a REST API

Created: 2017-08-30 18:27:47.0

Updated: 2017-08-30 18:28:04.0

Pushed: 2017-09-11 18:44:04.0

Homepage: null

Size: 18

Language: Python

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

A REST API for on- and off-boarding users to/from our GitHub Organization

This RESTful Flask/Python 3 application can do three things:

1. Tell you if a user is a member of our organization.
2. Invite a user to join our organization.
3. Remove a user from our organization, including all teams that are part of the organization.

It's designed to be used in an automated on-boarding/off-boarding workflow. This would be facilitated by having a field for GitHub username in Employee Self Service.

NOTE: At the moment, this app does not implement any authentication. Anyone on the campus intranet will be able to access it (though it is not currently deployed anywhere). Before the app is deployed, we will probably require that all access comes via SysEng boxes (such as jamborite).

Running the app

You must set the following environment variables:

Environment variable name | Purpose ————————- | ——- GITHUB_ORG | The name of the GitHub organization, presumably FredHutch. GITHUB_TOKEN | A GitHub access token which must have the permissions admin:org and read:user.

API

There is a single endpoint (/). Different actions are accomplished with different HTTP verbs:

HTTP verb | action ———— | —————- GET | determine if user is member of org DELETE | remove user from org (and org teams) PUT | add user to org

API Documentation

The following examples assume that the application is deployed at https://toolbox.fhcrc.org/github-on-off-boarding/.

They involve a user with the username foo. Note that this is the GitHub username, not a HutchNet ID or any other kind of identifier.

GET

Determines if user is a member of the organization.

Example call:

 https://toolbox.fhcrc.org/github-on-off-boarding/?username=foo

Example result:

"status": false

PUT

Invites the user to join the organization. They will have to accept the invitation, by clicking a link in an email.

Example call:

 -X PUT https://toolbox.fhcrc.org/github-on-off-boarding/?username=foo

Example result:

"status": true

DELETE

Removes the user from all teams in the organization and then from the organization itself.

Example call:

 -X DELETE https://toolbox.fhcrc.org/github-on-off-boarding/?username=foo

Example result:

"status": true