Struct InstallationToken 

pub struct InstallationToken { /* private fields */ }

Installation-scoped access token for GitHub API operations.

Installation tokens provide access to perform operations on behalf of a specific installation. They have a 1-hour lifetime and include permission and repository scope information.

The token string is never exposed in Debug output for security.

Examples

use github_bot_sdk::auth::{InstallationToken, InstallationId, InstallationPermissions, Permission, RepositoryId};
use chrono::{Utc, Duration};

let installation_id = InstallationId::new(456);
let expires_at = Utc::now() + Duration::hours(1);
let permissions = InstallationPermissions::default();
let repositories = vec![RepositoryId::new(789)];

let token = InstallationToken::new(
    "ghs_token".to_string(),
    installation_id,
    expires_at,
    permissions,
    repositories,
);

assert_eq!(token.installation_id(), installation_id);
assert!(!token.is_expired());

Implementations

impl InstallationToken

pub fn new( token: String, installation_id: InstallationId, expires_at: DateTime<Utc>, permissions: InstallationPermissions, repositories: Vec<RepositoryId>, ) -> Self

Create a new installation token.

Arguments

• token - The token string from GitHub API
• installation_id - The installation this token is for
• expires_at - When the token expires (typically 1 hour)
• permissions - The permissions granted to this token
• repositories - The repositories this token can access

pub fn token(&self) -> &str

Get the token string for use in API requests.

This should be included in the Authorization header as: Authorization: Bearer <token>

pub fn installation_id(&self) -> InstallationId

Get the installation ID this token is for.

pub fn issued_at(&self) -> DateTime<Utc>

Get when this token was issued.

pub fn expires_at(&self) -> DateTime<Utc>

Get when this token expires.

pub fn permissions(&self) -> &InstallationPermissions

Get the permissions granted to this token.

pub fn repositories(&self) -> &[RepositoryId]

Get the repositories this token can access.

pub fn is_expired(&self) -> bool

Check if the token is currently expired.

pub fn expires_soon(&self, margin: Duration) -> bool

Check if the token will expire soon.

Arguments

• margin - How far in the future to check (e.g., 5 minutes)

Returns true if the token will expire within the margin period.

pub fn has_permission(&self, permission: Permission) -> bool

Check if the token has a specific permission.

Examples

let mut permissions = InstallationPermissions::default();
permissions.issues = PermissionLevel::Write;

let token = InstallationToken::new(
    "token".to_string(),
    InstallationId::new(1),
    Utc::now() + Duration::hours(1),
    permissions,
    vec![],
);

assert!(token.has_permission(Permission::ReadIssues));
assert!(token.has_permission(Permission::WriteIssues));
assert!(!token.has_permission(Permission::WriteContents));

pub fn can_access_repository(&self, repo_id: RepositoryId) -> bool

Check if the token can access a specific repository.

Trait Implementations

impl Clone for InstallationToken

fn clone(&self) -> InstallationToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstallationToken

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.