Skip to content
Kindgi

client.connections.requests

View as Markdown

client.connections.requests — the connections.requests operations.

On AsyncKindgi every method is the same, awaited.

client.connections.requests.get()

Section titled “client.connections.requests.get()”
get(request_id: str | UUID, /, *, timeout: float | None = None) -> ConnectRequest
Signature

Fetch a connect request. GET /v1/connections/requests/{requestId}

A member's request is the member's alone; the company's is a tenant admin's. Anyone else gets the 404 of a request that doesn't exist.

client.connections.requests.start()

Section titled “client.connections.requests.start()”
start(
    request_id: str | UUID,
    body: StartConnectBody | Mapping[str, Any] | None = None,
    /,
    *,
    idempotency_key: str | None = None,
    timeout: float | None = None,
    **fields: Any,
) -> ConnectStart
Signature

Start a connect request. POST /v1/connections/requests/{requestId}/start

Makes a fresh sign-in state, good for 10 minutes, and returns the app's consent page to send the person to. Records who started it: only they may finish it. A repeat starts again and never gets the first answer back: with an Idempotency-Key, a retry gets 409 idempotency-key-replay-withheld. A GitHub App's goes to the app's install page while the app has no installation, or with newInstallation; otherwise to GitHub's authorization, and the finish attaches the installation picked with installationId, one of the request's installations.