API referenceSign-in and account
Start signing in with GitHub
POST
Starts the GitHub device flow for sign-in. Show userCode, open verificationUri, then call auth.githubPoll every intervalSeconds. UNAVAILABLE while the OAuth client id is a placeholder.
Needs no sign-in. Not available to MCP clients or the assistant.
application/json- body
Success.
application/json- response
ticket*stringuserCode*stringverificationUri*stringexpiresAt*stringFormat
date-timeintervalSeconds*integerRange
1 <= valuecurl -X POST 'https://example.com/api/v1/auth.githubStart' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "ticket": "string", "userCode": "string", "verificationUri": "string", "expiresAt": "2019-08-24T14:15:22Z", "intervalSeconds": 1}Check a GitHub sign-in POST
Polls the device flow. With status done it signs in the person linked to that GitHub login (result holds the LoginResult); noAccount when nobody is linked to it. Needs no sign-in. Not available to MCP clients or the assistant.
Unlink your GitHub login POST
Removes the linked GitHub login and its stored token. Fails when it is the only way this account can sign in. Any signed-in caller. Not available to MCP clients or the assistant.