v1

latestOpenAPI 3.0.32026-07-17136180270.3 KB

Credentials

Start GitHub authorization-code OAuth

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

post/api/projects/{projectId}/credentials/github-git/authorize

projectIdstring required

Project identifier used to scope the request.

enterpriseUrlstring

enterprise Url value for the git Hub Authorize Request object.

redirectUristring

OAuth redirect URI.

scopesstring[]

Collection of scope values.

credentialIdstring

Credential identifier.

namestring

Human-readable name.

descriptionstring

Optional human-readable description.

inactiveboolean nullable

inactive value for the git Hub Authorize Request object.

Authorization URL

urlstring required

URL for a browser or API client to use.

verifierstring required

PKCE verifier used by OAuth code exchange.

statestring required

OAuth state correlation value.

redirectUristring required

OAuth redirect URI.

callbackListeningboolean required

callback Listening value for the git Hub Authorize Response object.