Skip to main content

startGithubAuthorization

Add a GitHub connection, step 1: the GitHub user-authorization URL for an installation just made.

startGithubAuthorization(
input: StartGithubAuthorizationInput!
): StartGithubAuthorizationPayload

Arguments​

startGithubAuthorization.input ● StartGithubAuthorizationInput! non-null input​

Parameters for StartGithubAuthorization

Type​

StartGithubAuthorizationPayload object​

Autogenerated return type of StartGithubAuthorization.

Example request

This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the companies query first and use data.companies.collection[].id as companyId.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"mutation MutateStartGithubAuthorization($input: StartGithubAuthorizationInput!) {\n startGithubAuthorization(input: $input) { authorizationUrl clientMutationId }\n}","variables":{"input":{"companyId":"<company_id>","installationId":"<installation_id>","usesAdvancedSecurity":true}}}'

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute