board-github

POST /v1/board-github/discover

List the GitHub Projects a credential can see.

Všechny koncové body board-github

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako pole v těle JSON.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X POST https://api.zinndigital.com/v1/board-github/discover \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "owner_login": <string> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Asked before anything is linked, so the customer picks a project from a list rather than pasting a node id. Reads **both** owner shapes — GitHub's `organization` query returns null for a user login and `user` returns null for an org login, so a single-shape read would answer "no projects" for half of all customers with no error anywhere. `count` is returned beside `projects` deliberately: an owner with genuinely no projects and a credential that cannot *see* any would otherwise be the same empty array.

Tělo požadavku

NázevTypPožadovánoCo to je
owner_loginstringAno
auth_kindGitHubAuthKindNe`app` is the Zinn® GitHub App installation — per-repository scope the customer chooses on GitHub's own screen, revocable by them in one click, belonging to their organisation ra…
installation_idstringNe
tokenstringNeA fine-grained token, for `auth_kind: pat`. Write-only and never echoed — a response carrying it would put a live GitHub credential in the browser's network tab and in any log t…
org_idstringNe

Odpověď

NázevTypPožadovánoCo to je
owner_loginstringNe
countintegerNeReturned beside the list on purpose. An owner with genuinely no projects and a credential that cannot see any would otherwise be the same empty array.
projectsGitHubProjectSummary[]Ne

Chyby, které může tento koncový bod vrátit

401 · 403 · 422