Verify or confirm your own GitHub identity

POST/api/chat-endpoints/{endpointId}/github/identity
Personal API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Verify or confirm your own GitHub identity.

Resolves the current user's personal connection and verifies GET /user with GitHub. Omitting confirmedGithubUserId previews the identity; supplying its exact ID explicitly confirms ownership after revalidation.

Authorization

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. How keys work.

Path parameters

endpointIdstring (uuid)RequiredThe endpoint's id.

Request body

application/json · required

connectionIdstring (uuid)Required
confirmedGithubUserIdstringOptionalpattern: ^[1-9][0-9]*$

Responses

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
502GitHub returned an invalid response or unavailable capability
503GitHub is temporarily unavailableA dependency is unavailable; retry with backoff.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Chat channels