Struct github_app_auth::GithubAuthParams

pub struct GithubAuthParams {
    pub user_agent: String,
    pub private_key: Vec<u8>,
    pub installation_id: u64,
    pub app_id: u64,
}

Input parameters for authenticating as a GitHub app. This is used to get an installation access token.

Fields

user_agent: String

User agent set for all requests to GitHub. The API requires that a user agent is set: https://docs.github.com/en/rest/overview/resources-in-the-rest-api#user-agent-required

They “request that you use your GitHub username, or the name of your application”.

private_key: Vec<u8>

Private key used to sign access token requests. You can generate a private key at the bottom of the application’s settings page.

installation_id: u64

GitHub application installation ID. To find this value you can look at the app installation’s configuration URL.

• For organizations this is on the “Installed GitHub Apps” page in your organization’s settings page.

• For personal accounts, go to the “Applications” page and select the “Installed GitHub Apps” tab.

The installation ID will be the final component of the path, for example “1216616” is the installation ID for “github.com/organizations/mycoolorg/settings/installations/1216616”.

app_id: u64

GitHub application ID. You can find this in the application settings page on GitHub under “App ID”.

Trait Implementations

impl Clone for GithubAuthParams

fn clone(&self) -> GithubAuthParams

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for GithubAuthParams

fn default() -> GithubAuthParams

Returns the “default value” for a type.