board-github

POST `/v1/board-github/discover`

List the GitHub Projects a credential can see.

การยืนยันตัวตน

ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา

ตำแหน่งสำหรับใส่รหัสองค์กรของคุณ

Endpoint นี้รับ org_id เป็นฟิลด์ใน JSON body

รหัสองค์กรของคุณจะแสดงอยู่บนหน้าคีย์ 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_login`	`string`	ใช่	—
`auth_kind`	`GitHubAuthKind`	ไม่ใช่	`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`	ไม่ใช่	—
`token`	`string`	ไม่ใช่	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`	ไม่ใช่	—

การตอบกลับ

ชื่อ	ประเภท	จำเป็นต้องมี	ลักษณะของสิ่งนี้
`owner_login`	`string`	ไม่ใช่	—
`count`	`integer`	ไม่ใช่	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[]`	ไม่ใช่	—

ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้

401 · 403 · 422

POST /v1/board-github/discover