Struct JsonWebToken 

pub struct JsonWebToken { /* private fields */ }

JWT token for GitHub App authentication.

JSON Web Tokens (JWTs) are used to authenticate as a GitHub App. They have a maximum lifetime of 10 minutes and are used to obtain installation tokens.

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

Examples

use github_bot_sdk::auth::{JsonWebToken, GitHubAppId};
use chrono::{Utc, Duration};

let app_id = GitHubAppId::new(123);
let expires_at = Utc::now() + Duration::minutes(10);
let jwt = JsonWebToken::new("encoded.jwt.token".to_string(), app_id, expires_at);

assert!(!jwt.is_expired());
assert_eq!(jwt.app_id(), app_id);

Implementations

impl JsonWebToken

pub fn new( token: String, app_id: GitHubAppId, expires_at: DateTime<Utc>, ) -> Self

Create a new JWT token.

Arguments

• token - The encoded JWT string
• app_id - The GitHub App ID this token represents
• expires_at - When the token expires (max 10 minutes from creation)

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 app_id(&self) -> GitHubAppId

Get the GitHub App ID this token represents.

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 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 time_until_expiry(&self) -> Duration

Get the time remaining until expiry.

Trait Implementations

impl Clone for JsonWebToken

fn clone(&self) -> JsonWebToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonWebToken

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

Formats the value using the given formatter.