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 કન્સોલ તમારી વાસ્તવિક સંસ્થાની આઈડી અને તમારી પોતાની કી ભરે છે, અને લાઇવ API સામે વિનંતી ચલાવે છે જેથી તમે વાસ્તવિક પ્રતિસાદ જોઈ શકો. આ અંતિમબિંદુને 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…
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…
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