C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.Authentication.BearerAuthenticationToken Class Reference

An AccessToken storing Bearer authentication information for requests made to the server, specifically for tokens obtained from Okta. More...

Public Member Functions

 BearerAuthenticationToken ()
 Construct a new unauthorized BearerAuthenticationToken.
 
 BearerAuthenticationToken (string token, DateTime expirationTime)
 Construct a new BearerAuthenticationToken with a token and expiration.
 
bool IsExpired ()
 Checks if the token is expired.
 
override string ToString ()
 Returns the representation of this access token that could be placed in an "Authorization" header.
 

Properties

string access_token [get, set]
 The AccessToken identifier.
 
string AuthorizationMethod [get]
 The Authorization Method included in the Authorization header.
 
DateTime ExpirationTime [get]
 Expiration time of the token.
 
AccessTokenStatus status = AccessTokenStatus.Unknown [get, set]
 The AccessToken's current AccessTokenStatus (unauthorized / valid).
 

Detailed Description

An AccessToken storing Bearer authentication information for requests made to the server, specifically for tokens obtained from Okta.

Definition at line 9 of file BearerAuthenticationToken.cs.

Inheritance diagram for AnalyzeRe.Authentication.BearerAuthenticationToken:
AnalyzeRe.Authentication.IAccessToken

Constructor & Destructor Documentation

◆ BearerAuthenticationToken() [1/2]

AnalyzeRe.Authentication.BearerAuthenticationToken.BearerAuthenticationToken ( )
inline

Construct a new unauthorized BearerAuthenticationToken.

Definition at line 34 of file BearerAuthenticationToken.cs.

◆ BearerAuthenticationToken() [2/2]

AnalyzeRe.Authentication.BearerAuthenticationToken.BearerAuthenticationToken ( string  token,
DateTime  expirationTime 
)
inline

Construct a new BearerAuthenticationToken with a token and expiration.

Parameters
tokenThe token string.
expirationTimeThe expiration time of the token.

Definition at line 41 of file BearerAuthenticationToken.cs.

Member Function Documentation

◆ IsExpired()

bool AnalyzeRe.Authentication.BearerAuthenticationToken.IsExpired ( )
inline

Checks if the token is expired.

Returns
True if the token is expired, otherwise false.

Definition at line 51 of file BearerAuthenticationToken.cs.

◆ ToString()

override string AnalyzeRe.Authentication.BearerAuthenticationToken.ToString ( )

Returns the representation of this access token that could be placed in an "Authorization" header.

Returns
The representation of this access token that could be placed in an "Authorization" header.

Property Documentation

◆ access_token

string AnalyzeRe.Authentication.BearerAuthenticationToken.access_token
getset

The AccessToken identifier.

Implements AnalyzeRe.Authentication.IAccessToken.

Definition at line 24 of file BearerAuthenticationToken.cs.

◆ AuthorizationMethod

string AnalyzeRe.Authentication.BearerAuthenticationToken.AuthorizationMethod
get

The Authorization Method included in the Authorization header.

Implements AnalyzeRe.Authentication.IAccessToken.

Definition at line 14 of file BearerAuthenticationToken.cs.

◆ ExpirationTime

DateTime AnalyzeRe.Authentication.BearerAuthenticationToken.ExpirationTime
get

Expiration time of the token.

Definition at line 29 of file BearerAuthenticationToken.cs.

◆ status

AccessTokenStatus AnalyzeRe.Authentication.BearerAuthenticationToken.status = AccessTokenStatus.Unknown
getset

The AccessToken's current AccessTokenStatus (unauthorized / valid).

Implements AnalyzeRe.Authentication.IAccessToken.

Definition at line 19 of file BearerAuthenticationToken.cs.


The documentation for this class was generated from the following file: