Tgstation.Server.Api.ApiHeaders Class Reference

Represents the header that must be present for every server request. More...

Collaboration diagram for Tgstation.Server.Api.ApiHeaders:

Public Member Functions
	ApiHeaders (ProductHeaderValue userAgent, TokenResponse token)
	Initializes a new instance of the ApiHeaders class. Used for token authentication.
	ApiHeaders (ProductHeaderValue userAgent, string oAuthCode, OAuthProvider oAuthProvider)
	Initializes a new instance of the ApiHeaders class. Used for token authentication.
	ApiHeaders (ProductHeaderValue userAgent, string username, string password)
	Initializes a new instance of the ApiHeaders class. Used for password authentication.
	ApiHeaders (RequestHeaders requestHeaders, bool ignoreMissingAuth, bool allowEventStreamAccept)
	Initializes a new instance of the ApiHeaders class.
bool	Compatible (Version? alternateApiVersion=null)
	Checks if the ApiVersion is compatible with Version.
void	SetRequestHeaders (HttpRequestHeaders headers, long? instanceId=null)
	Set HttpRequestHeaders using the ApiHeaders. This initially clears headers .
void	SetHubConnectionHeaders (IDictionary< string, string > headers)
	Adds the headers necessary for a SignalR hub connection.

Static Public Member Functions
static bool	CheckCompatibility (Version otherVersion)
	Checks if a given otherVersion is compatible with our own.

Static Public Attributes
const string	ApiVersionHeader = "Api"
	The ApiVersion header key.
const string	InstanceIdHeader = "Instance"
	The InstanceId header key.
const string	OAuthProviderHeader = "OAuthProvider"
	The OAuthProvider header key.
const string	BearerAuthenticationScheme = "Bearer"
	The JWT authentication header scheme.
const string	BasicAuthenticationScheme = "Basic"
	The JWT authentication header scheme.
const string	OAuthAuthenticationScheme = "OAuth"
	The JWT authentication header scheme.
const string	ApplicationJsonMime = "application/json"
	Added to MediaTypeNames.Application in netstandard2.1. Can't use because of lack of .NET Framework support.
static readonly Version	Version = Version.Parse(ApiVersionAttribute.Instance.RawApiVersion)
	Get the version of the Api the caller is using.

Properties
long?	InstanceId [get, set]
	The instance EntityId.Id being accessed.
ProductHeaderValue?	UserAgent [get]
	The client's user agent as a ProductHeaderValue if valid.
string?	RawUserAgent [get]
	The client's raw user agent.
Version	ApiVersion [get]
	The client's API version.
TokenResponse?	Token [get]
	The client's TokenResponse.
string?	Username [get]
	The client's username.
string?	Password [get]
	The client's password.
string?	OAuthCode [get]
	The OAuth code in use.
OAuthProvider?	OAuthProvider [get]
	The Models.OAuthProvider the Token is for, if any.
bool	IsTokenAuthentication [get]
	If the header uses OAuth or TGS JWT authentication.

Private Member Functions
	ApiHeaders (ProductHeaderValue userAgent, TokenResponse? token, string? username, string? password)
	Initializes a new instance of the ApiHeaders class.
string	CreateApiVersionHeader ()
	Create the stringified for of the ApiVersionHeader.

Static Private Attributes
const string	TextEventStreamMime = "text/event-stream"
	Added to MediaTypeNames.Application in netstandard2.1. Can't use because of lack of .NET Framework support.
static readonly AssemblyName	AssemblyName = Assembly.GetExecutingAssembly().GetName()
	The current System.Reflection.AssemblyName.
static readonly char[]	ColonSeparator = [':']
	A char Array containing the ':' char.

Detailed Description

Represents the header that must be present for every server request.

Definition at line 24 of file ApiHeaders.cs.

Constructor & Destructor Documentation

ApiHeaders() [1/5]

Tgstation.Server.Api.ApiHeaders.ApiHeaders	(	ProductHeaderValue	userAgent,
		TokenResponse	token
	)

Initializes a new instance of the ApiHeaders class. Used for token authentication.

Parameters

userAgent	The value of UserAgent.
token	The value of Token.

Definition at line 143 of file ApiHeaders.cs.

            : this(userAgent, token, null, null)
        {
            if (userAgent == null)
                throw new ArgumentNullException(nameof(userAgent));
            if (token == null)
                throw new ArgumentNullException(nameof(token));
            if (token.Bearer == null)
                throw new InvalidOperationException("token.Bearer must be set!");
        }

References Tgstation.Server.Api.Models.Response.TokenResponse.Bearer.

ApiHeaders() [2/5]

Tgstation.Server.Api.ApiHeaders.ApiHeaders	(	ProductHeaderValue	userAgent,
		string	oAuthCode,
		OAuthProvider	oAuthProvider
	)

Initializes a new instance of the ApiHeaders class. Used for token authentication.

Parameters

userAgent	The value of UserAgent.
oAuthCode	The value of OAuthCode.
oAuthProvider	The value of OAuthProvider.

Definition at line 160 of file ApiHeaders.cs.

            : this(userAgent, null, null, null)
        {
            if (userAgent == null)
                throw new ArgumentNullException(nameof(userAgent));
 
            OAuthCode = oAuthCode ?? throw new ArgumentNullException(nameof(oAuthCode));
            OAuthProvider = oAuthProvider;
        }

References Tgstation.Server.Api.ApiHeaders.OAuthCode.

ApiHeaders() [3/5]

Tgstation.Server.Api.ApiHeaders.ApiHeaders	(	ProductHeaderValue	userAgent,
		string	username,
		string	password
	)

Initializes a new instance of the ApiHeaders class. Used for password authentication.

Parameters

userAgent	The value of UserAgent.
username	The value of Username.
password	The value of Password.

Definition at line 176 of file ApiHeaders.cs.

            : this(userAgent, null, username, password)
        {
            if (userAgent == null)
                throw new ArgumentNullException(nameof(userAgent));
            if (username == null)
                throw new ArgumentNullException(nameof(username));
            if (password == null)
                throw new ArgumentNullException(nameof(password));
        }

ApiHeaders() [4/5]

Tgstation.Server.Api.ApiHeaders.ApiHeaders	(	RequestHeaders	requestHeaders,
		bool	ignoreMissingAuth,
		bool	allowEventStreamAccept
	)

Initializes a new instance of the ApiHeaders class.

Parameters

requestHeaders	The RequestHeaders containing the serialized ApiHeaders.
ignoreMissingAuth	If a missing HeaderNames.Authorization should be ignored.
allowEventStreamAccept	If TextEventStreamMime is a valid accept.

Exceptions

HeadersException

Thrown if the requestHeaders constitue invalid ApiHeaders.

Definition at line 195 of file ApiHeaders.cs.

        {
            if (requestHeaders == null)
                throw new ArgumentNullException(nameof(requestHeaders));
 
            var badHeaders = HeaderErrorTypes.None;
            var errorBuilder = new StringBuilder();
            var multipleErrors = false;
            void AddError(HeaderErrorTypes headerType, string message)
            {
                if (badHeaders != HeaderErrorTypes.None)
                {
                    multipleErrors = true;
                    errorBuilder.AppendLine();
                }
 
                badHeaders |= headerType;
                errorBuilder.Append(message);
            }
 
            var jsonAccept = new Microsoft.Net.Http.Headers.MediaTypeHeaderValue(ApplicationJsonMime);
            var eventStreamAccept = new Microsoft.Net.Http.Headers.MediaTypeHeaderValue(TextEventStreamMime);
            if (!requestHeaders.Accept.Any(accept => accept.IsSubsetOf(jsonAccept)))
                if (!allowEventStreamAccept)
                    AddError(HeaderErrorTypes.Accept, $"Client does not accept {ApplicationJsonMime}!");
                else if (!requestHeaders.Accept.Any(eventStreamAccept.IsSubsetOf))
                    AddError(HeaderErrorTypes.Accept, $"Client does not accept {ApplicationJsonMime} or {TextEventStreamMime}!");
 
            if (!requestHeaders.Headers.TryGetValue(HeaderNames.UserAgent, out var userAgentValues) || userAgentValues.Count == 0)
                AddError(HeaderErrorTypes.UserAgent, $"Missing {HeaderNames.UserAgent} header!");
            else
            {
                RawUserAgent = userAgentValues.First();
                if (String.IsNullOrWhiteSpace(RawUserAgent))
                    AddError(HeaderErrorTypes.UserAgent, $"Malformed {HeaderNames.UserAgent} header!");
            }
 
            // make sure the api header matches ours
            Version? apiVersion = null;
            if (!requestHeaders.Headers.TryGetValue(ApiVersionHeader, out var apiUserAgentHeaderValues) || !ProductInfoHeaderValue.TryParse(apiUserAgentHeaderValues.FirstOrDefault(), out var apiUserAgent) || apiUserAgent.Product.Name != AssemblyName.Name)
                AddError(HeaderErrorTypes.Api, $"Missing {ApiVersionHeader} header!");
            else if (!Version.TryParse(apiUserAgent.Product.Version, out apiVersion))
                AddError(HeaderErrorTypes.Api, $"Malformed {ApiVersionHeader} header!");
 
            if (!requestHeaders.Headers.TryGetValue(HeaderNames.Authorization, out StringValues authorization))
            {
                if (!ignoreMissingAuth)
                    AddError(HeaderErrorTypes.AuthorizationMissing, $"Missing {HeaderNames.Authorization} header!");
            }
            else
            {
                var auth = authorization.First();
                var splits = new List<string>(auth.Split(' '));
                var scheme = splits.First();
                if (String.IsNullOrWhiteSpace(scheme))
                    AddError(HeaderErrorTypes.AuthorizationInvalid, "Missing authentication scheme!");
                else
                {
                    splits.RemoveAt(0);
                    var parameter = String.Concat(splits);
                    if (String.IsNullOrEmpty(parameter))
                        AddError(HeaderErrorTypes.AuthorizationInvalid, "Missing authentication parameter!");
                    else
                    {
                        if (requestHeaders.Headers.TryGetValue(InstanceIdHeader, out var instanceIdValues))
                        {
                            var instanceIdString = instanceIdValues.FirstOrDefault();
                            if (instanceIdString != default && Int64.TryParse(instanceIdString, out var instanceId))
                                InstanceId = instanceId;
                        }
 
                        switch (scheme)
                        {
                            case OAuthAuthenticationScheme:
                                if (requestHeaders.Headers.TryGetValue(OAuthProviderHeader, out StringValues oauthProviderValues))
                                {
                                    var oauthProviderString = oauthProviderValues.First();
                                    if (Enum.TryParse<OAuthProvider>(oauthProviderString, true, out var oauthProvider))
                                        OAuthProvider = oauthProvider;
                                    else
                                        AddError(HeaderErrorTypes.OAuthProvider, "Invalid OAuth provider!");
                                }
                                else
                                    AddError(HeaderErrorTypes.OAuthProvider, $"Missing {OAuthProviderHeader} header!");
 
                                OAuthCode = parameter;
                                break;
                            case BearerAuthenticationScheme:
                                Token = new TokenResponse
                                {
                                    Bearer = parameter,
                                };
 
                                try
                                {
                                    Token.ParseJwt();
                                }
                                catch (ArgumentException ex) when (ex is not ArgumentNullException)
                                {
                                    AddError(HeaderErrorTypes.AuthorizationInvalid, $"Invalid JWT: {ex.Message}");
                                }
 
                                break;
                            case BasicAuthenticationScheme:
                                string badBasicAuthHeaderMessage = $"Invalid basic {HeaderNames.Authorization} header!";
                                string joinedString;
                                try
                                {
                                    var base64Bytes = Convert.FromBase64String(parameter);
                                    joinedString = Encoding.UTF8.GetString(base64Bytes);
                                }
                                catch
                                {
                                    AddError(HeaderErrorTypes.AuthorizationInvalid, badBasicAuthHeaderMessage);
                                    break;
                                }
 
                                var basicAuthSplits = joinedString.Split(ColonSeparator, StringSplitOptions.RemoveEmptyEntries);
                                if (basicAuthSplits.Length < 2)
                                {
                                    AddError(HeaderErrorTypes.AuthorizationInvalid, badBasicAuthHeaderMessage);
                                    break;
                                }
 
                                Username = basicAuthSplits.First();
                                Password = String.Concat(basicAuthSplits.Skip(1));
                                break;
                            default:
                                AddError(HeaderErrorTypes.AuthorizationInvalid, "Invalid authentication scheme!");
                                break;
                        }
                    }
                }
            }
 
            if (badHeaders != HeaderErrorTypes.None)
            {
                if (multipleErrors)
                    errorBuilder.Insert(0, $"Multiple header validation errors occurred:{Environment.NewLine}");
 
                throw new HeadersException(badHeaders, errorBuilder.ToString());
            }
 
            ApiVersion = apiVersion!.Semver();
        }

References Tgstation.Server.Api.ApiHeaders.ApiVersion, Tgstation.Server.Api.ApiHeaders.ApiVersionHeader, Tgstation.Server.Api.ApiHeaders.ApplicationJsonMime, Tgstation.Server.Api.ApiHeaders.AssemblyName, Tgstation.Server.Api.ApiHeaders.BasicAuthenticationScheme, Tgstation.Server.Api.ApiHeaders.BearerAuthenticationScheme, Tgstation.Server.Api.ApiHeaders.ColonSeparator, Tgstation.Server.Api.ApiHeaders.InstanceId, Tgstation.Server.Api.ApiHeaders.InstanceIdHeader, Tgstation.Server.Api.ApiHeaders.OAuthAuthenticationScheme, Tgstation.Server.Api.ApiHeaders.OAuthCode, Tgstation.Server.Api.ApiHeaders.OAuthProviderHeader, Tgstation.Server.Api.Models.Response.TokenResponse.ParseJwt(), Tgstation.Server.Api.ApiHeaders.Password, Tgstation.Server.Api.ApiHeaders.RawUserAgent, Tgstation.Server.Api.ApiHeaders.TextEventStreamMime, Tgstation.Server.Api.ApiHeaders.Token, Tgstation.Server.Api.ApiHeaders.Username, and Tgstation.Server.Api.ApiHeaders.Version.

Here is the call graph for this function:

ApiHeaders() [5/5]

Tgstation.Server.Api.ApiHeaders.ApiHeaders ( ProductHeaderValue  userAgent, TokenResponse?  token, string?  username, string?  password  )

private

Initializes a new instance of the ApiHeaders class.

Parameters

userAgent	The value of UserAgent.
token	The value of Token.
username	The value of Username.
password	The value of Password.

Definition at line 349 of file ApiHeaders.cs.

        {
            RawUserAgent = userAgent?.ToString();
            Token = token;
            Username = username;
            Password = password;
            ApiVersion = Version;
        }

References Tgstation.Server.Api.ApiHeaders.ApiVersion, Tgstation.Server.Api.ApiHeaders.Password, Tgstation.Server.Api.ApiHeaders.RawUserAgent, Tgstation.Server.Api.ApiHeaders.Token, Tgstation.Server.Api.ApiHeaders.Username, and Tgstation.Server.Api.ApiHeaders.Version.

Member Function Documentation

CheckCompatibility()

static bool Tgstation.Server.Api.ApiHeaders.CheckCompatibility ( Version  otherVersion )

static

Checks if a given otherVersion is compatible with our own.

Parameters

otherVersion

The Version to test.

Returns

true if the given version is compatible with the API. false otherwise.

Compatible()

bool Tgstation.Server.Api.ApiHeaders.Compatible

(

Version?

alternateApiVersion = null

)

Checks if the ApiVersion is compatible with Version.

Parameters

alternateApiVersion

The System.Version that can alternatively be used as the ApiVersion.

Returns

true if the API is compatible, false otherwise.

CreateApiVersionHeader()

string Tgstation.Server.Api.ApiHeaders.CreateApiVersionHeader ( )

private

Create the stringified for of the ApiVersionHeader.

Returns

A string representing the ApiVersion.

Referenced by Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

Here is the caller graph for this function:

SetHubConnectionHeaders()

void Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders

(

IDictionary< string, string >

headers

)

Adds the headers necessary for a SignalR hub connection.

Parameters

headers

The headers IDictionary<TKey, TValue> to write to.

Definition at line 402 of file ApiHeaders.cs.

        {
            if (headers == null)
                throw new ArgumentNullException(nameof(headers));
 
            headers.Add(HeaderNames.UserAgent, RawUserAgent ?? throw new InvalidOperationException("Missing UserAgent!"));
            headers.Add(HeaderNames.Accept, ApplicationJsonMime);
            headers.Add(ApiVersionHeader, CreateApiVersionHeader());
        }

References Tgstation.Server.Api.ApiHeaders.ApiVersionHeader, Tgstation.Server.Api.ApiHeaders.ApplicationJsonMime, Tgstation.Server.Api.ApiHeaders.CreateApiVersionHeader(), and Tgstation.Server.Api.ApiHeaders.RawUserAgent.

Referenced by Tgstation.Server.Client.ApiClient.CreateHubConnection< THubImplementation >().

Here is the call graph for this function:

Here is the caller graph for this function:

SetRequestHeaders()

void Tgstation.Server.Api.ApiHeaders.SetRequestHeaders	(	HttpRequestHeaders	headers,
		long?	instanceId = null
	)

Set HttpRequestHeaders using the ApiHeaders. This initially clears headers .

Parameters

headers	The HttpRequestHeaders to set.
instanceId	The instance EntityId.Id for the request.

Definition at line 370 of file ApiHeaders.cs.

        {
            if (headers == null)
                throw new ArgumentNullException(nameof(headers));
            if (instanceId.HasValue && InstanceId.HasValue && instanceId != InstanceId)
                throw new InvalidOperationException("Specified different instance IDs in constructor and SetRequestHeaders!");
 
            headers.Clear();
            headers.Accept.Add(new MediaTypeWithQualityHeaderValue(ApplicationJsonMime));
            headers.UserAgent.Add(new ProductInfoHeaderValue(UserAgent));
            headers.Add(ApiVersionHeader, CreateApiVersionHeader());
            if (OAuthProvider.HasValue)
            {
                headers.Authorization = new AuthenticationHeaderValue(OAuthAuthenticationScheme, OAuthCode!);
                headers.Add(OAuthProviderHeader, OAuthProvider.ToString());
            }
            else if (!IsTokenAuthentication)
                headers.Authorization = new AuthenticationHeaderValue(
                    BasicAuthenticationScheme,
                    Convert.ToBase64String(Encoding.UTF8.GetBytes($"{Username}:{Password}")));
            else
                headers.Authorization = new AuthenticationHeaderValue(BearerAuthenticationScheme, Token!.Bearer);
 
            instanceId ??= InstanceId;
            if (instanceId.HasValue)
                headers.Add(InstanceIdHeader, instanceId.Value.ToString(CultureInfo.InvariantCulture));
        }

References Tgstation.Server.Api.ApiHeaders.ApiVersionHeader, Tgstation.Server.Api.ApiHeaders.ApplicationJsonMime, Tgstation.Server.Api.ApiHeaders.BasicAuthenticationScheme, Tgstation.Server.Api.ApiHeaders.BearerAuthenticationScheme, Tgstation.Server.Api.ApiHeaders.CreateApiVersionHeader(), Tgstation.Server.Api.ApiHeaders.InstanceId, Tgstation.Server.Api.ApiHeaders.InstanceIdHeader, Tgstation.Server.Api.ApiHeaders.IsTokenAuthentication, Tgstation.Server.Api.ApiHeaders.OAuthAuthenticationScheme, Tgstation.Server.Api.ApiHeaders.OAuthCode, Tgstation.Server.Api.ApiHeaders.OAuthProviderHeader, Tgstation.Server.Api.ApiHeaders.Token, and Tgstation.Server.Api.ApiHeaders.UserAgent.

Referenced by Tgstation.Server.Client.ApiClient.RunRequest< TResult >().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ApiVersionHeader

const string Tgstation.Server.Api.ApiHeaders.ApiVersionHeader = "Api"

static

The ApiVersion header key.

Definition at line 29 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.SetupServiceProvider().

ApplicationJsonMime

const string Tgstation.Server.Api.ApiHeaders.ApplicationJsonMime = "application/json"

static

Added to MediaTypeNames.Application in netstandard2.1. Can't use because of lack of .NET Framework support.

Definition at line 59 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Client.ApiClient.RunRequest< TBody, TResult >(), Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

AssemblyName

readonly AssemblyName Tgstation.Server.Api.ApiHeaders.AssemblyName = Assembly.GetExecutingAssembly().GetName()

staticprivate

The current System.Reflection.AssemblyName.

Definition at line 74 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders().

BasicAuthenticationScheme

const string Tgstation.Server.Api.ApiHeaders.BasicAuthenticationScheme = "Basic"

static

The JWT authentication header scheme.

Definition at line 49 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.CreateFromLogin(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

BearerAuthenticationScheme

const string Tgstation.Server.Api.ApiHeaders.BearerAuthenticationScheme = "Bearer"

static

The JWT authentication header scheme.

Definition at line 44 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.CreateFromToken(), Tgstation.Server.Host.IO.FileDownloader.DownloadFile(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Host.Security.OAuth.GenericOAuthValidator.ValidateResponseCode().

ColonSeparator

readonly char [] Tgstation.Server.Api.ApiHeaders.ColonSeparator = [':']

staticprivate

A char Array containing the ':' char.

Definition at line 79 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders().

InstanceIdHeader

const string Tgstation.Server.Api.ApiHeaders.InstanceIdHeader = "Instance"

static

The InstanceId header key.

Definition at line 34 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

OAuthAuthenticationScheme

const string Tgstation.Server.Api.ApiHeaders.OAuthAuthenticationScheme = "OAuth"

static

The JWT authentication header scheme.

Definition at line 54 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.CreateFromOAuth(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

OAuthProviderHeader

const string Tgstation.Server.Api.ApiHeaders.OAuthProviderHeader = "OAuthProvider"

static

The OAuthProvider header key.

Definition at line 39 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.SetupServiceProvider().

TextEventStreamMime

const string Tgstation.Server.Api.ApiHeaders.TextEventStreamMime = "text/event-stream"

staticprivate

Added to MediaTypeNames.Application in netstandard2.1. Can't use because of lack of .NET Framework support.

Definition at line 64 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders().

Version

readonly Version Tgstation.Server.Api.ApiHeaders.Version = Version.Parse(ApiVersionAttribute.Instance.RawApiVersion)

static

Get the version of the Api the caller is using.

Definition at line 69 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ErrorMessageResponse(), Tgstation.Server.Host.Controllers.ControlPanelController.GetChannelJson(), and Tgstation.Server.Host.Controllers.ApiRootController.ServerInfo().

Property Documentation

ApiVersion

Version Tgstation.Server.Api.ApiHeaders.ApiVersion

get

The client's API version.

Definition at line 99 of file ApiHeaders.cs.

{ get; }

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), and Tgstation.Server.Host.Controllers.ApiController.HookExecuteAction().

InstanceId

long? Tgstation.Server.Api.ApiHeaders.InstanceId

getset

The instance EntityId.Id being accessed.

Definition at line 84 of file ApiHeaders.cs.

{ get; set; }

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Controllers.ApiController.HookExecuteAction(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Host.Security.AuthenticationContextFactory.ValidateToken().

IsTokenAuthentication

bool Tgstation.Server.Api.ApiHeaders.IsTokenAuthentication

get

If the header uses OAuth or TGS JWT authentication.

Definition at line 129 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

OAuthCode

string? Tgstation.Server.Api.ApiHeaders.OAuthCode

get

The OAuth code in use.

Definition at line 119 of file ApiHeaders.cs.

{ get; }

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Host.Authority.LoginAuthority.TryOAuthenticate< TResult >().

OAuthProvider

OAuthProvider? Tgstation.Server.Api.ApiHeaders.OAuthProvider

get

The Models.OAuthProvider the Token is for, if any.

Definition at line 124 of file ApiHeaders.cs.

{ get; }

Password

string? Tgstation.Server.Api.ApiHeaders.Password

get

The client's password.

Definition at line 114 of file ApiHeaders.cs.

{ get; }

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), and Tgstation.Server.Api.ApiHeaders.ApiHeaders().

RawUserAgent

string? Tgstation.Server.Api.ApiHeaders.RawUserAgent

get

The client's raw user agent.

Definition at line 94 of file ApiHeaders.cs.

{ get; }

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Controllers.ApiController.HookExecuteAction(), and Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders().

Token

TokenResponse? Tgstation.Server.Api.ApiHeaders.Token

get

The client's TokenResponse.

Definition at line 104 of file ApiHeaders.cs.

{ get; }

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Client.ApiClient.RefreshToken(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

UserAgent

ProductHeaderValue? Tgstation.Server.Api.ApiHeaders.UserAgent

get

The client's user agent as a ProductHeaderValue if valid.

Definition at line 89 of file ApiHeaders.cs.

Referenced by Tgstation.Server.Client.ApiClient.RefreshToken(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

Username

string? Tgstation.Server.Api.ApiHeaders.Username

get

The client's username.

Definition at line 109 of file ApiHeaders.cs.

{ get; }

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), and Tgstation.Server.Api.ApiHeaders.ApiHeaders().

---

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

• src/Tgstation.Server.Api/ApiHeaders.cs