Skip to Content
kosemdocs
ReferenceAPIConnections

Start GitHub connection

Starts connecting GitHub: returns where the caller installs kosem's GitHub App, and the state that GitHub sends back. GitHub sends the person back to the console with a code, which CompleteGitHubConnection takes with the state, within 30 minutes.

POST
/v1/organizations/{organization}/connections/github/start

Starts connecting GitHub: returns where the caller installs kosem's GitHub App, and the state that GitHub sends back.

GitHub sends the person back to the console with a code, which CompleteGitHubConnection takes with the state, within 30 minutes.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

organization*string

The organization's ID.

Match^org_[0-7][0-9a-hjkmnp-tv-z]{25}$

Response Body

OK

application/json
  1. response
authorizeUri*string

Where the person authorizes kosem's GitHub App without installing it, to connect an installation of it that exists and that they manage; GitHub then sends them to GitHubCallback, as from installUri.

installUri*string

Where the person installs kosem's GitHub App, on an account and the repositories they choose. GitHub then sends them, with a code and state, to GitHubCallback, which connects the installation and goes on to the console.

state*string

Ties the installation to this organization and this person, for 30 minutes, which it names, signed; installUri and authorizeUri carry it. It starts with the organization's ID.

Example Request
curl -X POST 'https://api.kosem.ai/v1/organizations/string/connections/github/start'
Example Response
{
  "authorizeUri": "string",
  "installUri": "string",
  "state": "string"
}