C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.Authentication.BasicAuthenticationToken Class Reference

An AccessToken storing basic authentication information for requests made to the server. More...

Public Member Functions

 BasicAuthenticationToken ()
 Instantiate a new BasicAuthenticationToken More...
 
 BasicAuthenticationToken (string username, string password)
 Instantiate a new BasicAuthenticationToken with supplied username and password parameters supplied. More...
 
void GenerateAccessToken (string token_username, string token_password)
 Provide basic authentication credentials so the user can log in. More...
 
override string ToString ()
 Returns the representation of this access token that could be placed in an "Authorization" header. More...
 

Public Attributes

string AuthorizationMethod => "Basic"
 The Authorization Method included in the Authorization header. More...
 

Properties

string access_token = AccessTokenStatus.Unknown [get, set]
 The AccessToken identifier. More...
 
SecureString password [get]
 The password associated with this authentication token. More...
 
AccessTokenStatus status [get, set]
 The AccessToken's current AccessTokenStatus (unauthorized / valid). More...
 
string username [get]
 The username associated with this authentication token. More...
 

Detailed Description

An AccessToken storing basic authentication information for requests made to the server.

Definition at line 11 of file BasicAuthenticationToken.cs.

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

Constructor & Destructor Documentation

AnalyzeRe.Authentication.BasicAuthenticationToken.BasicAuthenticationToken ( )
inline

Instantiate a new BasicAuthenticationToken

Definition at line 29 of file BasicAuthenticationToken.cs.

AnalyzeRe.Authentication.BasicAuthenticationToken.BasicAuthenticationToken ( string  username,
string  password 
)
inline

Instantiate a new BasicAuthenticationToken with supplied username and password parameters supplied.

Parameters
usernameThe username
passwordThe password

Definition at line 35 of file BasicAuthenticationToken.cs.

Member Function Documentation

void AnalyzeRe.Authentication.BasicAuthenticationToken.GenerateAccessToken ( string  token_username,
string  token_password 
)
inline

Provide basic authentication credentials so the user can log in.

Parameters
token_usernameThe username
token_passwordThe password

Definition at line 43 of file BasicAuthenticationToken.cs.

override string AnalyzeRe.Authentication.BasicAuthenticationToken.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.

Member Data Documentation

string AnalyzeRe.Authentication.BasicAuthenticationToken.AuthorizationMethod => "Basic"

The Authorization Method included in the Authorization header.

Definition at line 14 of file BasicAuthenticationToken.cs.

Property Documentation

string AnalyzeRe.Authentication.BasicAuthenticationToken.access_token = AccessTokenStatus.Unknown
getset

The AccessToken identifier.

Definition at line 20 of file BasicAuthenticationToken.cs.

SecureString AnalyzeRe.Authentication.BasicAuthenticationToken.password
get

The password associated with this authentication token.

Definition at line 26 of file BasicAuthenticationToken.cs.

AccessTokenStatus AnalyzeRe.Authentication.BasicAuthenticationToken.status
getset

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

Definition at line 17 of file BasicAuthenticationToken.cs.

string AnalyzeRe.Authentication.BasicAuthenticationToken.username
get

The username associated with this authentication token.

Definition at line 23 of file BasicAuthenticationToken.cs.


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