Struct graph_oauth::oauth::AccessToken

pub struct AccessToken { /* private fields */ }

OAuth 2.0 Access Token

Create a new AccessToken.

Example

let access_token = AccessToken::new("Bearer", 3600, "Read Read.Write", "ASODFIUJ34KJ;LADSK");

You can also get the claims using the claims() method as well as the remaining duration that the access token is valid using the elapsed() method.

Tokens returned for personal microsoft accounts that use legacy MSA are encrypted and cannot be parsed. This bearer token may still be valid but the jwt() method will return None. For more info see: Microsoft identity platform acccess tokens

For tokens where the JWT can be parsed the elapsed() method uses the exp field in the JWT’s claims. If the claims do not contain an exp field or the token could not be parsed the elapsed() method uses the expires_in field returned in the response body to caculate the remaining time. These fields are only used once during initialization to set a timestamp for future expiration of the access token.

Example

// Claims
println!("{:#?}", access_token.claims());

// Duration left until expired.
println!("{:#?}", access_token.elapsed());

Implementations

impl AccessToken

pub fn new(
    token_type: &str,
    expires_in: i64,
    scope: &str,
    access_token: &str
) -> AccessToken

pub fn set_token_type(&mut self, s: &str) -> &mut AccessToken

Set the token type.

Example

let mut access_token = AccessToken::default();
access_token.set_token_type("Bearer");

pub fn set_expires_in(&mut self, expires_in: i64) -> &mut AccessToken

Set the expies in time. This should usually be done in seconds.

Example

let mut access_token = AccessToken::default();
access_token.set_expires_in(3600);

pub fn set_scope(&mut self, s: &str) -> &mut AccessToken

Set the scope.

Example

let mut access_token = AccessToken::default();
access_token.set_scope("Read Read.Write");

pub fn set_bearer_token(&mut self, s: &str) -> &mut AccessToken

Set the access token.

Example

let mut access_token = AccessToken::default();
access_token.set_bearer_token("ASODFIUJ34KJ;LADSK");

pub fn set_refresh_token(&mut self, s: &str) -> &mut AccessToken

Set the refresh token.

Example

let mut access_token = AccessToken::default();
access_token.set_refresh_token("#ASOD323U5342");

pub fn set_user_id(&mut self, s: &str) -> &mut AccessToken

Set the user id.

Example

let mut access_token = AccessToken::default();
access_token.set_user_id("user_id");

pub fn set_id_token(&mut self, s: &str) -> &mut AccessToken

Set the id token.

Example

let mut access_token = AccessToken::default();
access_token.set_id_token("id_token");

pub fn with_id_token(&mut self, id_token: IdToken)

Set the id token.

Example

let mut access_token = AccessToken::default();
access_token.with_id_token(IdToken::new("id_token", "code", "state", "session_state"));

pub fn set_state(&mut self, s: &str) -> &mut AccessToken

Set the state.

Example

let mut access_token = AccessToken::default();
access_token.set_state("state");

pub fn gen_timestamp(&mut self)

Reset the access token timestmap.

Example

let mut access_token = AccessToken::default();
access_token.timestamp();
// The timestamp is in UTC.

pub fn token_type(&self) -> &str

Get the token type.

Example

let mut access_token = AccessToken::default();
println!("{:#?}", access_token.token_type());

pub fn expires_in(&self) -> i64

Set the user id.

Example

let mut access_token = AccessToken::default();
// This is the original amount that was set not the difference.
// To get the difference you can use access_token.elapsed().
println!("{:#?}", access_token.expires_in());

pub fn scopes(&self) -> Option<&String>

Get the scopes.

Example

let mut access_token = AccessToken::default();
println!("{:#?}", access_token.scopes());

pub fn bearer_token(&self) -> &str

Get the access token.

Example

let mut access_token = AccessToken::default();
println!("{:#?}", access_token.bearer_token());

pub fn user_id(&self) -> Option<String>

Get the user id.

Example

let mut access_token = AccessToken::default();
println!("{:#?}", access_token.user_id());

pub fn refresh_token(&self) -> Option<String>

Get the refresh token.

Example

let mut access_token = AccessToken::default();
println!("{:#?}", access_token.refresh_token());

pub fn id_token(&self) -> Option<String>

Get the id token.

Example

let mut access_token = AccessToken::default();
println!("{:#?}", access_token.id_token());

pub fn state(&self) -> Option<String>

Get the state.

Example

let mut access_token = AccessToken::default();
println!("{:#?}", access_token.state());

pub fn timestamp(&self) -> Option<DateTime<Utc>>

Get the timestamp.

Example

let mut access_token = AccessToken::default();
println!("{:#?}", access_token.timestamp());

pub fn is_expired(&self) -> bool

Check whether the access token is expired. An access token is considerd expired when there is a negative difference between the timestamp set for the access token and the expires_in field.

Example

let mut access_token = AccessToken::default();
println!("{:#?}", access_token.is_expired());

pub fn elapsed(&self) -> Option<HumanTime>

Get the time left in seconds until the access token expires. See the HumanTime crate. If you just need to know if the access token is expired then use the is_expired() message which returns a boolean true for the token has expired and false otherwise.

Example

let mut access_token = AccessToken::default();
println!("{:#?}", access_token.elapsed());

pub fn claims(&self) -> Option<Vec<Claim>>

pub fn jwt(&self) -> Option<&JsonWebToken>

Trait Implementations

impl AsFile for AccessToken

type Error = FromAsError

fn as_file<P: AsRef<Path>>(&self, path: P) -> Result<(), Self::Error>

fn as_file_pretty<P: AsRef<Path>>(&self, path: P) -> Result<(), Self::Error>

impl Clone for AccessToken

fn clone(&self) -> AccessToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccessToken

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

Formats the value using the given formatter.

impl Default for AccessToken

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AccessToken

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl FromFile<AccessToken> for AccessToken

type Error = FromAsError

fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, Self::Error> where
    for<'de> Self: Deserialize<'de>, 

impl PartialEq<AccessToken> for AccessToken

fn eq(&self, other: &AccessToken) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &AccessToken) -> bool

This method tests for !=.

impl Serialize for AccessToken

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ str> for AccessToken

type Error = GraphFailure

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RequestBuilder> for AccessToken

type Error = GraphFailure

The type returned in the event of a conversion error.

fn try_from(value: RequestBuilder) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Response> for AccessToken

type Error = GraphFailure

The type returned in the event of a conversion error.

fn try_from(value: Response) -> Result<Self, Self::Error> where
    Self: for<'de> Deserialize<'de>, 

Performs the conversion.

impl TryFrom<Result<Response, Error>> for AccessToken

type Error = GraphFailure

The type returned in the event of a conversion error.

fn try_from(value: Result<Response, Error>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for AccessToken

impl StructuralEq for AccessToken

impl StructuralPartialEq for AccessToken