board-github
POST /v1/board-github/discover
List the GitHub Projects a credential can see.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
A szervezet azonosítójának helye
Ez a végpont a org_id mezőt várja a JSON törzsben.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
owner_login | string | Igen | — |
auth_kind | GitHubAuthKind | Nem | `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_id | string | Nem | — |
token | string | Nem | A 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_id | string | Nem | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
owner_login | string | Nem | — |
count | integer | Nem | Returned 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. |
projects | GitHubProjectSummary[] | Nem | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 422