---
title: "Start GitHub authorization-code OAuth"
method: POST
path: "/api/projects/{projectId}/credentials/github-git/authorize"
tags: ["Credentials"]
---

# Start GitHub authorization-code OAuth

`POST /api/projects/{projectId}/credentials/github-git/authorize`

Start GitHub authorization-code OAuth. Accepts a JSON request body when defined and returns the resulting resource or action status.

## Path parameters

- `projectId` string, required

## Request body

- GitHubAuthorizeRequest — git Hub Authorize Request payload accepted by the API.
  - `enterpriseUrl` string — enterprise Url value for the git Hub Authorize Request object.
  - `redirectUri` string — OAuth redirect URI.
  - `scopes` string[] — Collection of scope values.
  - `credentialId` string — Credential identifier.
  - `name` string — Human-readable name.
  - `description` string — Optional human-readable description.
  - `visibility` CredentialVisibility — credential Visibility API object.
    - `tools` boolean, required — Collection of tool values.
    - `console` boolean, required — console value for the credential Visibility object.
    - `services` boolean, required — Collection of service values.
    - `hooks` boolean, required — Collection of hook values.
  - `inactive` boolean, nullable — inactive value for the git Hub Authorize Request object.

## Response `200`

Authorization URL

- GitHubAuthorizeResponse — git Hub Authorize Response payload returned by the API.
  - `url` string, required — URL for a browser or API client to use.
  - `verifier` string, required — PKCE verifier used by OAuth code exchange.
  - `state` string, required — OAuth state correlation value.
  - `redirectUri` string, required — OAuth redirect URI.
  - `callbackListening` boolean, required — callback Listening value for the git Hub Authorize Response object.

---

[API](https://skmtc.net/ibuildthecloud/apis/discobot-server-api.md) · [All operations](https://skmtc.net/ibuildthecloud/apis/discobot-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ibuildthecloud/discobot-server-api/versions/4de3fcd6be56/schema)