Start GitHub App install | Writ

Returns the GitHub App install URL carrying a short-lived state nonce. Requires the signed-in portal session (with CSRF header) or a tenant API key, plus TOTP step-up. After GitHub redirects back to /v1/github/setup, the installation is bound to the tenant and the consent record is created.

Request

This endpoint expects an object.

totpCodestringOptional

TOTP code or single-use backup code.

Response

Install URL and expiry.

installUrlstringOptional

expiresAtintegerOptional

Errors

401

Unauthorized Error

403

Forbidden Error