Skip to content
Docs

Give a hire its own GitHub identity

POST
/api/workspaces/{ws}/github/{connection}/hires/{hire}/app

Starts GitHub's app-manifest flow. Body: { owner: "organization", org: "acme" } or { owner: "personal" }. Answers with where to send the person: GitHub creates the app, then asks which repositories to install it on.

Authorization

session
cookiebetter-auth.session_token<token>

Set by POST /api/auth/sign-in/email.

Path Parameters

ws*string

The workspace id (from GET /api/me).

connection*string

The connection's id (from GET /api/workspaces/:ws/connections).

hire*string

The hire's id.

Response Body

Where to continue on GitHub.

Example Request
curl -X POST 'https://app.useroster.work/api/workspaces/string/github/string/hires/string/app'
Example Response
Empty

A hire's GitHub identity GET

`{ set: false }`, or the app: its `login` (e.g. `builder-acme[bot]`), whether it's `installed`, how many repositories it reaches, and links to manage it on GitHub.

Take a hire's GitHub identity away DELETE

Roster forgets the app; delete it on GitHub too if nothing else uses it.