Function GetScopes

pkg/cmd/auth/shared/oauth_scopes.go:36–66

GetScopes performs a GitHub API request and returns the value of the X-Oauth-Scopes header.

(httpClient httpClient, hostname, authToken string)

// GetScopes performs a GitHub API request and returns the value of the X-Oauth-Scopes header.
func GetScopes(httpClient httpClient, hostname, authToken string) (string, error) {
	apiEndpoint, err := safeurl.JoinPathWithHostPrefix(ghinstance.RESTPrefix(hostname))
	if err != nil {
		return "", err
	}

	req, err := http.NewRequest("GET", apiEndpoint.String(), nil)
	if err != nil {
		return "", err
	}

	req.Header.Set("Authorization", "token "+authToken)

	res, err := httpClient.Do(req)
	if err != nil {
		return "", err
	}

	defer func() {
		// Ensure the response body is fully read and closed
		// before we reconnect, so that we reuse the same TCPconnection.
		_, _ = io.Copy(io.Discard, res.Body)
		res.Body.Close()
	}()

	if res.StatusCode != 200 {
		return "", api.HandleHTTPError(res)
	}

	return res.Header.Get("X-Oauth-Scopes"), nil
}

// HasMinimumScopes performs a GitHub API request and returns an error if the token used in the request
// lacks the minimum required scopes for performing API operations with gh.