board-github

POST `/v1/board-github/discover`

List the GitHub Projects a credential can see.

Tous les points de terminaison board-github

Toute la documentation pour développeurs →

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Où insérer l'ID de votre organisation

Cet endpoint prend org_id comme champ dans le corps JSON.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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.

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`owner_login`	`string`	Oui	—
`auth_kind`	`GitHubAuthKind`	Non	`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_id`	`string`	Non	—
`token`	`string`	Non	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_id`	`string`	Non	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`owner_login`	`string`	Non	—
`count`	`integer`	Non	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[]`	Non	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 422