Package com.atlassian.bamboo.plugins.github.apps

Interface GithubAppsService

All Known Implementing Classes:
GithubAppsServiceImpl
public interface GithubAppsService
Service interface for interacting with GitHub Apps to obtain access tokens.
Since:
12.0

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Optional<String>
    getAccessToken(@NotNull String appId, @NotNull String privateKey, @NotNull String apiBaseUrl, @NotNull String owner, @NotNull String repo)
    Retrieves an access token for the specified repository.

  • Method Details

    • getAccessToken

      @NotNull @NotNull Optional<String> getAccessToken(@NotNull @NotNull String appId, @NotNull @NotNull String privateKey, @NotNull @NotNull String apiBaseUrl, @NotNull @NotNull String owner, @NotNull @NotNull String repo)
      Retrieves an access token for the specified repository.
      Parameters:
      appId - the GitHub App ID
      privateKey - the private key of the GitHub App
      apiBaseUrl - the base URL of the GitHub API
      owner - the owner of the repository
      repo - the name of the repository
      Returns:
      an Optional containing the access token if successful, otherwise an empty Optional