Struct github_app_auth::InstallationAccessToken

pub struct InstallationAccessToken {
    pub client: Client,
    pub refresh_safety_margin: Duration,
    // some fields omitted
}

An installation access token is the primary method for authenticating with the GitHub API as an application.

Fields

client: Client

The reqwest::blocking::Client used to periodically refresh the token.

This is made public so that users of the library can re-use this client for sending requests, but this is not required.

refresh_safety_margin: Duration

This time is subtracted from the expiration time to make it less likely that the token goes out of date just as a request is sent.

Implementations

impl InstallationAccessToken

pub fn new(
    params: GithubAuthParams
) -> Result<InstallationAccessToken, AuthError>

Fetch an installation access token using the provided authentication parameters.

pub fn header(&mut self) -> Result<HeaderMap, AuthError>

Get an HTTP authentication header for the installation access token.

This method is mutable because the installation access token must be periodically refreshed.