---
title: "Validate Github Auth Endpoint"
method: POST
path: "/v1/connectors/validate-github-auth"
tags: ["v1-connectors"]
---

# Validate Github Auth Endpoint

`POST /v1/connectors/validate-github-auth`

Validate GitHub authentication credentials.

For PAT auth, this verifies the token is valid and retrieves the authenticated user.
For OAuth/GitHub App auth, this validates the app credentials.

Args:
    auth_type: "pat" or "oauth"
    access_token: GitHub Personal Access Token (for PAT auth)
    app_id, installation_id, private_key: GitHub App credentials (for OAuth)

Returns:
    {
        "valid": bool,
        "status": "valid" | "invalid" | "error",
        "message": str,
        "username": str | None  # The authenticated user/app name
    }

## Request body

- ValidateGitHubAuthRequest
  - `auth_type` 'pat' | 'oauth'
  - `access_token` string, nullable
  - `app_id` string, nullable
  - `installation_id` string, nullable
  - `private_key` string, nullable

## Response `200`

Successful Response

- GitHubAuthValidationResponse
  - `valid` boolean, required
  - `status` 'valid' | 'invalid' | 'error', required
  - `message` string, required
  - `username` string, nullable, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/tryardent/apis/fastapi.md) · [All operations](https://skmtc.net/tryardent/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tryardent/fastapi/revisions/71b66f68e19c/schema)