board-github

POST /v1/board-github/discover

List the GitHub Projects a credential can see.

ټول board-github پای ټکي

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

چیرته چې ستاسو د سازمان آی ډي ځي

دا پای ټکی د JSON په متن کې د یوې ساحې په توګه org_id اخلي.

ستاسو د سازمان آی ډي ستاسو په ډشبورډ کې د API کېلي پر سکرین، خپله د کېلي څنګ ته شتون لري. دا په هره هغه غوښتنه کې چې تاسو یې کوئ، ورته آی ډي وي.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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> }'

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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.

د غوښتنې بدن

نومډولاړیندا څه شی دی
owner_loginstringهو
auth_kindGitHubAuthKindنه`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_idstringنه
tokenstringنه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_idstringنه

ځواب

نومډولاړیندا څه شی دی
owner_loginstringنه
countintegerنه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.
projectsGitHubProjectSummary[]نه

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 422