diff --git a/_administration_controller_8cs_source.html b/_administration_controller_8cs_source.html index adfd9c8216..ccc10188f0 100644 --- a/_administration_controller_8cs_source.html +++ b/_administration_controller_8cs_source.html @@ -523,7 +523,7 @@ $(document).ready(function() { init_codefold(0); });
Go to the source code of this file.
+Go to the source code of this file.
Classes | |
| class | Tgstation.Server.Host.GraphQL.Mutations.Payloads.LoginPayload |
| Success response for a login attempt. More... | |
| class | Tgstation.Server.Host.GraphQL.Mutations.Payloads.LoginResult |
| Success response for a login attempt. More... | |
diff --git a/_login_payload_8cs_source.html b/_login_result_8cs_source.html
similarity index 67%
rename from _login_payload_8cs_source.html
rename to _login_result_8cs_source.html
index e63b25dd3d..ae3692be82 100644
--- a/_login_payload_8cs_source.html
+++ b/_login_result_8cs_source.html
@@ -5,7 +5,7 @@
-LoginPayload.cs LoginResult.cs
+Go to the documentation of this file.
diff --git a/_login_result_extensions_8cs_source.html b/_login_result_extensions_8cs_source.html
index c780437a96..5b335bd440 100644
--- a/_login_result_extensions_8cs_source.html
+++ b/_login_result_extensions_8cs_source.html
@@ -129,30 +129,28 @@ $(document).ready(function() { init_codefold(0); });
-
-
-
-
-
-
-
-
-
-
@@ -91,34 +91,35 @@ $(document).ready(function() { init_codefold(0); });
-
+
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
+
-
+
Represents a JWT returned by the API. Definition TokenResponse.cs:9 Success response for a login attempt. Definition LoginPayload.cs:12 required string Bearer The JSON Web Token (JWT) to use as a Bearer token for accessing the server. Contains an expiry time. Definition LoginPayload.cs:17 TokenResponse ToApi() Success response for a login attempt. Definition LoginResult.cs:12 TokenResponse ToApi() required string Bearer The JSON Web Token (JWT) to use as a Bearer token for accessing the server. Contains an expiry time. Definition LoginResult.cs:18 Definition User.cs:17 Represents a host-side model that may be transformed into a TApiModel . Definition ILegacyApiTransformable{TApiModel}.cs:8 Definition ChatBot.cs:9 65 throw new AuthenticationException($"Null bearer field and {errors.Count} non-ErrorMessage errors:{(errors.Count > 0 ? $"{Environment.NewLine}\t- {String.Join($"{Environment.NewLine}\t- ", errors)}" : String.Empty)}");
-
-
-
-
+
+
+
+
+
+
+
+
+ 64 throw new AuthenticationException($"Null bearer field and {errors.Count} non-ErrorMessage errors:{(errors.Count > 0 ? $"{Environment.NewLine}\t- {String.Join($"{Environment.NewLine}\t- ", errors)}" : String.Empty)}");
+
+
+
+
Extensions for ILoginResult. Definition LoginResultExtensions.cs:14 static JsonWebToken EnsureSuccess(this IOperationResult< ILoginResult > loginResult, ILogger logger) Check a given loginResult for errors. Definition LoginResultExtensions.cs:22 Definition ChatChannel.cs:6 Exception representing ErrorMessageResponses. Definition ErrorMessageException.cs:14 ValueTask< LoginPayload > Login([Service] IGraphQLAuthorityInvoker< ILoginAuthority > loginAuthority, CancellationToken cancellationToken) Generate a JWT for authenticating with server. This is the only operation that accepts and required b... Definition Mutation.cs:32 Success response for a login attempt. Definition LoginPayload.cs:12 ValueTask< LoginResult > Login([Service] IGraphQLAuthorityInvoker< ILoginAuthority > loginAuthority, CancellationToken cancellationToken) Generate a JWT for authenticating with server. This is the only operation that accepts and required b... Definition Mutation.cs:32 Invokes TAuthority s from GraphQL endpoints. Definition IGraphQLAuthorityInvoker{TAuthority}.cs:15 Definition ChatBot.cs:9 @ List User may list files if the Models.Instance allows it. Definition Application.cs:77 EventType Types of events. Mirror in tgs.dm. Prefer last listed name for script. Definition EventType.cs:7 Definition IJobManager.cs:8 Definition ChatBot.cs:9 Definition IJobManager.cs:8 ValueTask< IActionResult > Invoke(ApiController controller, Func< TAuthority, ValueTask< AuthorityResponse > > authorityInvoker) Invoke a TAuthority method with no success result. static string LogFormat(this IResult result, uint level=0) Converts a given result into a log entry string. Definition ResultExtensions.cs:23 Definition ApiHeaders.cs:20 Definition Application.cs:77 Handles mapping connection IDs to Users for a given THub . Definition IHubConnectionMapper.cs:19 Definition Application.cs:77 Definition IJobManager.cs:8 For identifying the current platform. Definition IPlatformIdentifier.cs:9 Reads and writes to Streams associated with FileTicketResponses. Definition IFileTransferStreamHandler.cs:14 @ Unauthorized The swarm private keys didn't match. static readonly TaskCompletionSource InfiniteTaskCompletionSource A TaskCompletionSource that never completes. Definition TaskExtensions.cs:13 Task Delay(TimeSpan timeSpan, CancellationToken cancellationToken) Create a Task that completes after a given timeSpan . ValueTask< AuthorityResponse > DeleteEmpty(long id, CancellationToken cancellationToken) Deletes an empty UserGroup. @ Id Lookup the Api.Models.EntityId.Id of the Models.PermissionSet. Definition Application.cs:77 Definition Application.cs:77 Definition IJobManager.cs:8 Definition Application.cs:77 ColonSeparator | Tgstation.Server.Api.ApiHeaders | privatestatic | Compatible() | Tgstation.Server.Api.ApiHeaders | InstanceIdHeader | Tgstation.Server.Api.ApiHeaders | static | | BearerAuthenticationScheme | Tgstation.Server.Api.ApiHeaders | static | CheckCompatibility(Version otherVersion) | Tgstation.Server.Api.ApiHeaders | static | Compatible(Version? alternateApiVersion=null) | Tgstation.Server.Api.ApiHeaders | CreateApiVersionHeader() | Tgstation.Server.Api.ApiHeaders | private | InstanceId | Tgstation.Server.Api.ApiHeaders | ||||
| ApiHeaders (RequestHeaders requestHeaders, bool ignoreMissingAuth, bool allowEventStreamAccept) | |||||||||||||||||||||||||
| Initializes a new instance of the ApiHeaders class. | |||||||||||||||||||||||||
| bool | Compatible () | ||||||||||||||||||||||||
| Checks if the ApiVersion is compatible with Version. | |||||||||||||||||||||||||
| 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 . | |||||||||||||||||||||||||
| bool Tgstation.Server.Api.ApiHeaders.Compatible | ( | -) | +Version? | +alternateApiVersion = null | ) | ||||||||||||||||||||
Checks if the ApiVersion is compatible with Version.
+| alternateApiVersion | The System.Version that can alternatively be used as the ApiVersion. |
true if the API is compatible, false otherwise.Create the stringified for of the ApiVersionHeader.
Referenced by Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().
+Referenced by Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().
Definition at line 401 of file ApiHeaders.cs.
-Definition at line 402 of file ApiHeaders.cs.
+References Tgstation.Server.Api.ApiHeaders.ApiVersionHeader, Tgstation.Server.Api.ApiHeaders.ApplicationJsonMime, Tgstation.Server.Api.ApiHeaders.CreateApiVersionHeader(), and Tgstation.Server.Api.ApiHeaders.RawUserAgent.
@@ -881,33 +888,33 @@ Here is the caller graph for this function:Definition at line 369 of file ApiHeaders.cs.
-Definition at line 370 of file ApiHeaders.cs.
+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().
+Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.SetupServiceProvider().
@@ -990,7 +997,7 @@ Here is the caller graph for this function: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().
+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().
@@ -1046,7 +1053,7 @@ Here is the caller graph for this function: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().
+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().
@@ -1074,7 +1081,7 @@ Here is the caller graph for this function: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().
+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().
@@ -1130,7 +1137,7 @@ Here is the caller graph for this function: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().
+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().
@@ -1158,7 +1165,7 @@ Here is the caller graph for this function: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().
+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().
@@ -1186,7 +1193,7 @@ Here is the caller graph for this function: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().
+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().
@@ -1301,7 +1308,7 @@ Here is the caller graph for this function:Definition at line 84 of file ApiHeaders.cs.
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().
+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().
@@ -1329,7 +1336,7 @@ Here is the caller graph for this function:Definition at line 129 of file ApiHeaders.cs.
-Referenced by Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().
+Referenced by Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().
@@ -1358,7 +1365,7 @@ Here is the caller graph for this function:Definition at line 119 of file ApiHeaders.cs.
Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().
+Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().
@@ -1443,7 +1450,7 @@ Here is the caller graph for this function:Definition at line 94 of file ApiHeaders.cs.
Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Controllers.ApiController.HookExecuteAction(), and Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders().
+Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Controllers.ApiController.HookExecuteAction(), and Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders().
@@ -1472,7 +1479,7 @@ Here is the caller graph for this function:Definition at line 104 of file ApiHeaders.cs.
Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Client.ApiClient.RefreshToken(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().
+Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Client.ApiClient.RefreshToken(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().
@@ -1500,7 +1507,7 @@ Here is the caller graph for this function:Definition at line 89 of file ApiHeaders.cs.
-Referenced by Tgstation.Server.Client.ApiClient.RefreshToken(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().
+Referenced by Tgstation.Server.Client.ApiClient.RefreshToken(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server.html index 2bc451a83c..8e47698b02 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server.html @@ -264,7 +264,7 @@ PropertiesDefinition at line 26 of file SwarmServer.cs.
Referenced by Tgstation.Server.Host.Swarm.SwarmService.CommitUpdate(), Tgstation.Server.Host.Controllers.InstanceController.Create(), Tgstation.Server.Host.Controllers.InstanceController.CreateDefaultInstance(), Tgstation.Server.Host.Controllers.InstanceController.Delete(), Tgstation.Server.Host.Utils.PortAllocator.GetAvailablePort(), Tgstation.Server.Host.Controllers.InstanceController.GetId(), Tgstation.Server.Host.Controllers.InstanceController.GrantPermissions(), Tgstation.Server.Host.Swarm.SwarmService.HealthCheckNodes(), Tgstation.Server.Host.Components.InstanceManager.Initialize(), Tgstation.Server.Host.Swarm.SwarmService.Initialize(), Tgstation.Server.Host.Controllers.InstanceController.List(), Tgstation.Server.Host.Swarm.SwarmService.PrepareSwarmRequest(), Tgstation.Server.Host.Swarm.SwarmService.PrepareUpdateImpl(), Tgstation.Server.Host.Swarm.SwarmService.RegisterNode(), Tgstation.Server.Host.Database.DatabaseSeeder.SanitizeDatabase(), Tgstation.Server.Host.Swarm.SwarmService.SendUpdatedServerListToNodes(), Tgstation.Server.Host.GraphQL.Types.SwarmNode.SwarmNode(), Tgstation.Server.Api.Models.Internal.SwarmServer.SwarmServer(), Tgstation.Server.Host.Swarm.SwarmService.SwarmService(), Tgstation.Server.Host.Controllers.InstanceController.Update(), Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseAdditionalRequestLoggingContext(), and Tgstation.Server.Host.Security.AuthenticationContextFactory.ValidateToken().
+Referenced by Tgstation.Server.Host.Swarm.SwarmService.CommitUpdate(), Tgstation.Server.Host.Controllers.InstanceController.Create(), Tgstation.Server.Host.Controllers.InstanceController.CreateDefaultInstance(), Tgstation.Server.Host.Controllers.InstanceController.Delete(), Tgstation.Server.Host.Utils.PortAllocator.GetAvailablePort(), Tgstation.Server.Host.Controllers.InstanceController.GetId(), Tgstation.Server.Host.Controllers.InstanceController.GrantPermissions(), Tgstation.Server.Host.Swarm.SwarmService.HealthCheckNodes(), Tgstation.Server.Host.Components.InstanceManager.Initialize(), Tgstation.Server.Host.Swarm.SwarmService.Initialize(), Tgstation.Server.Host.Controllers.InstanceController.List(), Tgstation.Server.Host.Swarm.SwarmService.PrepareSwarmRequest(), Tgstation.Server.Host.Swarm.SwarmService.PrepareUpdateImpl(), Tgstation.Server.Host.Swarm.SwarmService.RegisterNode(), Tgstation.Server.Host.Database.DatabaseSeeder.SanitizeDatabase(), Tgstation.Server.Host.Swarm.SwarmService.SendUpdatedServerListToNodes(), Tgstation.Server.Host.GraphQL.Types.SwarmNode.SwarmNode(), Tgstation.Server.Api.Models.Internal.SwarmServer.SwarmServer(), Tgstation.Server.Host.Swarm.SwarmService.SwarmService(), Tgstation.Server.Host.Controllers.InstanceController.Update(), Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseAdditionalRequestLoggingContext(), and Tgstation.Server.Host.Security.AuthenticationContextFactory.ValidateToken().
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html index 00703d7b5c..39386744bf 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html @@ -259,7 +259,7 @@ PropertiesDefinition at line 21 of file ErrorMessageResponse.cs.
Referenced by Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ErrorMessageResponse(), and Tgstation.Server.Host.Authority.LoginAuthority.GenerateHeadersExceptionResponse().
+Referenced by Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ErrorMessageResponse(), and Tgstation.Server.Host.Authority.LoginAuthority.GenerateHeadersExceptionResponse().
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html index 65f3751640..3dd71dc3ab 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html @@ -129,9 +129,9 @@ Here is the caller graph for this function: - + - + diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response_a8fc39cb31c7d4490f8fefe71c936aa12_icgraph.map b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response_a8fc39cb31c7d4490f8fefe71c936aa12_icgraph.map index d28b9ac46e..35b35c01ac 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response_a8fc39cb31c7d4490f8fefe71c936aa12_icgraph.map +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response_a8fc39cb31c7d4490f8fefe71c936aa12_icgraph.map @@ -2,8 +2,8 @@ - + - + diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response_a8fc39cb31c7d4490f8fefe71c936aa12_icgraph.md5 b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response_a8fc39cb31c7d4490f8fefe71c936aa12_icgraph.md5 index d0e7129346..40dfc396de 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response_a8fc39cb31c7d4490f8fefe71c936aa12_icgraph.md5 +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response_a8fc39cb31c7d4490f8fefe71c936aa12_icgraph.md5 @@ -1 +1 @@ -09ad91bf877987229bd8804e9475a945 \ No newline at end of file +18adb7fae7fee2cee2fcadad657acf8b \ No newline at end of file diff --git a/class_tgstation_1_1_server_1_1_client_1_1_api_client.html b/class_tgstation_1_1_server_1_1_client_1_1_api_client.html index 6fa537328f..23244fb79a 100644 --- a/class_tgstation_1_1_server_1_1_client_1_1_api_client.html +++ b/class_tgstation_1_1_server_1_1_client_1_1_api_client.html @@ -1109,7 +1109,7 @@ Static Private AttributesReferences Tgstation.Server.Client.ApiClient.Headers, Tgstation.Server.Api.Routes.JobsHub, Tgstation.Server.Client.ApiClient.SerializerSettings, Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders(), Tgstation.Server.Client.ApiClient.Timeout, and Tgstation.Server.Client.ApiClient.Url.
+References Tgstation.Server.Client.ApiClient.Headers, Tgstation.Server.Api.Routes.JobsHub, Tgstation.Server.Client.ApiClient.SerializerSettings, Tgstation.Server.Api.ApiHeaders.SetHubConnectionHeaders(), Tgstation.Server.Client.ApiClient.Timeout, and Tgstation.Server.Client.ApiClient.Url.
References Tgstation.Server.Common.Http.CachedResponseStream.Create(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().
+References Tgstation.Server.Common.Http.CachedResponseStream.Create(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().
This is the complete list of members for Tgstation.Server.Client.GraphQL.LoginResultExtensions, including all inherited members.
| bearer | Tgstation.Server.Client.GraphQL.LoginResultExtensions | private |
| Bearer | Tgstation.Server.Client.GraphQL.LoginResultExtensions | private |
| EnsureSuccess(this IOperationResult< ILoginResult > loginResult, ILogger logger) | Tgstation.Server.Client.GraphQL.LoginResultExtensions | static |

Private Attributes | |
| return | bearer |
| return data.LoginResult. | Bearer |
Extensions for ILoginResult.
@@ -195,29 +195,25 @@ Private AttributesReferences Tgstation.Server.Client.GraphQL.LoginResultExtensions.bearer.
-| return Tgstation.Server.Client.GraphQL.LoginResultExtensions.bearer | +return data.LoginResult. Tgstation.Server.Client.GraphQL.LoginResultExtensions.Bearer |
Definition at line 71 of file LoginResultExtensions.cs.
- -Referenced by Tgstation.Server.Client.GraphQL.LoginResultExtensions.EnsureSuccess().
+Definition at line 70 of file LoginResultExtensions.cs.
This is the complete list of members for Tgstation.Server.Host.Authority.LoginAuthority, including all inherited members.
| apiHeadersProvider | Tgstation.Server.Host.Authority.LoginAuthority | private | |||||||||
| AttemptLogin(CancellationToken cancellationToken) | Tgstation.Server.Host.Authority.LoginAuthority | ||||||||||
| AttemptLogin(CancellationToken cancellationToken) | Tgstation.Server.Host.Authority.LoginAuthority | ||||||||||
| AuthenticationContext | Tgstation.Server.Host.Authority.Core.AuthorityBase | protected | |||||||||
| AuthorityBase(IAuthenticationContext authenticationContext, IDatabaseContext databaseContext, ILogger< AuthorityBase > logger) | Tgstation.Server.Host.Authority.Core.AuthorityBase | protected | |||||||||
| BadRequest< TResult >(ErrorCode errorCode) | Tgstation.Server.Host.Authority.Core.AuthorityBase | protectedstatic | |||||||||
| CacheSystemIdentity(ISystemIdentity systemIdentity, User user, LoginPayload loginPayload) | Tgstation.Server.Host.Authority.LoginAuthority | private | |||||||||
| CacheSystemIdentity(ISystemIdentity systemIdentity, User user, LoginResult loginPayload) | Tgstation.Server.Host.Authority.LoginAuthority | private | |||||||||
| Conflict< TResult >(ErrorCode errorCode) | Tgstation.Server.Host.Authority.Core.AuthorityBase | protectedstatic | |||||||||
| cryptographySuite | Tgstation.Server.Host.Authority.LoginAuthority | private | |||||||||
| DatabaseContext | Tgstation.Server.Host.Authority.Core.AuthorityBase | protected | |||||||||
| Forbid< TResult >() | Tgstation.Server.Host.Authority.Core.AuthorityBase | protectedstatic | |||||||||
| GenerateHeadersExceptionResponse(HeadersException headersException) | Tgstation.Server.Host.Authority.LoginAuthority | privatestatic | |||||||||
| GenerateHeadersExceptionResponse(HeadersException headersException) | Tgstation.Server.Host.Authority.LoginAuthority | privatestatic | |||||||||
| Gone< TResult >() | Tgstation.Server.Host.Authority.Core.AuthorityBase | protectedstatic | |||||||||
| identityCache | Tgstation.Server.Host.Authority.LoginAuthority | private | |||||||||
| Logger | Tgstation.Server.Host.Authority.Core.AuthorityBase | protected | |||||||||
| LoginAuthority (IAuthenticationContext authenticationContext, IDatabaseContext databaseContext, ILogger< LoginAuthority > logger, IApiHeadersProvider apiHeadersProvider, ISystemIdentityFactory systemIdentityFactory, IOAuthProviders oAuthProviders, ITokenFactory tokenFactory, ICryptographySuite cryptographySuite, IIdentityCache identityCache, ISessionInvalidationTracker sessionInvalidationTracker) | |||||||||||
| Initializes a new instance of the LoginAuthority class. | |||||||||||
| async ValueTask< AuthorityResponse< LoginPayload > > | AttemptLogin (CancellationToken cancellationToken) | ||||||||||
Attempt to login to the server with the current crentials.
| |||||||||||
Private Member Functions | |
| async ValueTask | CacheSystemIdentity (ISystemIdentity systemIdentity, User user, LoginPayload loginPayload) |
| Add a given systemIdentity to the identityCache. | |
| async ValueTask | CacheSystemIdentity (ISystemIdentity systemIdentity, User user, LoginResult loginPayload) |
| Add a given systemIdentity to the identityCache. | |
Static Private Member Functions | ||||||||||||||
| static AuthorityResponse< LoginPayload > | GenerateHeadersExceptionResponse (HeadersException headersException) | |||||||||||||
| Generate an AuthorityResponse<TResult> for a given headersException . | ||||||||||||||
| static AuthorityResponse< LoginResult > | GenerateHeadersExceptionResponse (HeadersException headersException) | |||||||||||||
| Generate an AuthorityResponse<TResult> for a given headersException . | ||||||||||||||
| static async ValueTask< User?> | SelectUserInfoFromQuery (IQueryable< User > query, CancellationToken cancellationToken) | |||||||||||||
| Select the details needed to generate a TokenResponse from a given query . | ||||||||||||||
| async ValueTask< AuthorityResponse< LoginPayload > > Tgstation.Server.Host.Authority.LoginAuthority.AttemptLogin | +async ValueTask< AuthorityResponse< LoginResult > > Tgstation.Server.Host.Authority.LoginAuthority.AttemptLogin | ( | CancellationToken | cancellationToken | ) | @@ -369,19 +369,19 @@ Additional Inherited Members
Implements Tgstation.Server.Host.Authority.ILoginAuthority.
+Implements Tgstation.Server.Host.Authority.ILoginAuthority.
Definition at line 134 of file LoginAuthority.cs.
References Tgstation.Server.Host.Utils.IApiHeadersProvider.ApiHeaders, Tgstation.Server.Host.Authority.LoginAuthority.apiHeadersProvider, Tgstation.Server.Host.Authority.LoginAuthority.CacheSystemIdentity(), Tgstation.Server.Host.Models.User.CanonicalizeName(), Tgstation.Server.Host.Security.ICryptographySuite.CheckUserPassword(), Tgstation.Server.Host.Security.ISystemIdentityFactory.CreateSystemIdentity(), Tgstation.Server.Host.Security.ITokenFactory.CreateToken(), Tgstation.Server.Host.Authority.LoginAuthority.cryptographySuite, Tgstation.Server.Host.Authority.LoginAuthority.GenerateHeadersExceptionResponse(), Tgstation.Server.Host.Security.OAuth.IOAuthProviders.GetValidator(), Tgstation.Server.Host.Utils.IApiHeadersProvider.HeadersException, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Authority.Id, Tgstation.Server.Host.Authority.Core.AuthorityBase.Logger, Tgstation.Server.Host.Authority.LoginAuthority.oAuthProviders, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Authority.LoginAuthority.SelectUserInfoFromQuery(), Tgstation.Server.Host.Authority.LoginAuthority.sessionInvalidationTracker, Tgstation.Server.Host.Authority.LoginAuthority.systemIdentityFactory, Tgstation.Server.Host.Models.User.TgsSystemUserName, Tgstation.Server.Host.Models.User.ToApi(), Tgstation.Server.Host.Authority.LoginAuthority.tokenFactory, Tgstation.Server.Host.Security.ISystemIdentity.Uid, Tgstation.Server.Host.Security.ISessionInvalidationTracker.UserModifiedInvalidateSessions(), Tgstation.Server.Host.Security.ISystemIdentity.Username, and Tgstation.Server.Host.Database.DatabaseContext.Users.
+References Tgstation.Server.Host.Utils.IApiHeadersProvider.ApiHeaders, Tgstation.Server.Host.Authority.LoginAuthority.apiHeadersProvider, Tgstation.Server.Host.Authority.LoginAuthority.CacheSystemIdentity(), Tgstation.Server.Host.Models.User.CanonicalizeName(), Tgstation.Server.Host.Security.ICryptographySuite.CheckUserPassword(), Tgstation.Server.Host.Security.ISystemIdentityFactory.CreateSystemIdentity(), Tgstation.Server.Host.Security.ITokenFactory.CreateToken(), Tgstation.Server.Host.Authority.LoginAuthority.cryptographySuite, Tgstation.Server.Host.Authority.LoginAuthority.GenerateHeadersExceptionResponse(), Tgstation.Server.Host.Security.OAuth.IOAuthProviders.GetValidator(), Tgstation.Server.Host.Utils.IApiHeadersProvider.HeadersException, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Authority.Id, Tgstation.Server.Host.Authority.Core.AuthorityBase.Logger, Tgstation.Server.Host.Authority.LoginAuthority.oAuthProviders, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Authority.LoginAuthority.SelectUserInfoFromQuery(), Tgstation.Server.Host.Authority.LoginAuthority.sessionInvalidationTracker, Tgstation.Server.Host.Authority.LoginAuthority.systemIdentityFactory, Tgstation.Server.Host.Models.User.TgsSystemUserName, Tgstation.Server.Host.Models.User.ToApi(), Tgstation.Server.Host.Authority.LoginAuthority.tokenFactory, Tgstation.Server.Host.Security.ISystemIdentity.Uid, Tgstation.Server.Host.Security.ISessionInvalidationTracker.UserModifiedInvalidateSessions(), Tgstation.Server.Host.Security.ISystemIdentity.Username, and Tgstation.Server.Host.Database.DatabaseContext.Users.

| systemIdentity | The ISystemIdentity to cache. |
| user | The User the systemIdentity was generated for. |
| loginPayload | The LoginPayload for the successful login. |
| loginPayload | The LoginResult for the successful login. |
Definition at line 291 of file LoginAuthority.cs.
References Tgstation.Server.Host.Security.IIdentityCache.CacheSystemIdentity(), Tgstation.Server.Host.Authority.LoginAuthority.identityCache, Tgstation.Server.Api.Models.Response.TokenResponse.ParseJwt(), Tgstation.Server.Host.GraphQL.Mutations.Payloads.LoginPayload.ToApi(), Tgstation.Server.Host.Authority.LoginAuthority.tokenFactory, and Tgstation.Server.Host.Security.ITokenFactory.ValidationParameters.
+References Tgstation.Server.Host.Security.IIdentityCache.CacheSystemIdentity(), Tgstation.Server.Host.Authority.LoginAuthority.identityCache, Tgstation.Server.Api.Models.Response.TokenResponse.ParseJwt(), Tgstation.Server.Host.GraphQL.Mutations.Payloads.LoginResult.ToApi(), Tgstation.Server.Host.Authority.LoginAuthority.tokenFactory, and Tgstation.Server.Host.Security.ITokenFactory.ValidationParameters.
Referenced by Tgstation.Server.Host.Authority.LoginAuthority.AttemptLogin().




| static AuthorityResponse< LoginPayload > Tgstation.Server.Host.Authority.LoginAuthority.GenerateHeadersExceptionResponse | +static AuthorityResponse< LoginResult > Tgstation.Server.Host.Authority.LoginAuthority.GenerateHeadersExceptionResponse | ( | HeadersException | headersException | ) | @@ -718,7 +718,7 @@ Here is the caller graph for this function:
References Tgstation.Server.Api.Models.Response.ErrorMessageResponse.Message.
@@ -726,10 +726,10 @@ Here is the caller graph for this function:



Extensions for IApplicationBuilder.
-Definition at line 25 of file ApplicationBuilderExtensions.cs.
+Definition at line 26 of file ApplicationBuilderExtensions.cs.
Referenced by Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseCancelledRequestSuppression(), Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseDbConflictHandling(), and Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseServerErrorHandling().
+Referenced by Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseCancelledRequestSuppression(), Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseDbConflictHandling(), and Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseServerErrorHandling().
Definition at line 187 of file ApplicationBuilderExtensions.cs.
-Definition at line 190 of file ApplicationBuilderExtensions.cs.
+Definition at line 126 of file ApplicationBuilderExtensions.cs.
-Definition at line 127 of file ApplicationBuilderExtensions.cs.
+References Tgstation.Server.Host.Properties.MasterVersionsAttribute.Instance, and Tgstation.Server.Host.Properties.MasterVersionsAttribute.RawGraphQLVersion.
+Definition at line 71 of file ApplicationBuilderExtensions.cs.
-Definition at line 72 of file ApplicationBuilderExtensions.cs.
+References Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.GetLogger().
@@ -389,36 +396,36 @@ Here is the call graph for this function:Definition at line 36 of file ApplicationBuilderExtensions.cs.
-Definition at line 37 of file ApplicationBuilderExtensions.cs.
+References Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.GetLogger().
This is used to avoid interruption to SignalR streams by Nginx.
-Definition at line 170 of file ApplicationBuilderExtensions.cs.
-Definition at line 173 of file ApplicationBuilderExtensions.cs.
+Definition at line 153 of file ApplicationBuilderExtensions.cs.
-Definition at line 156 of file ApplicationBuilderExtensions.cs.
+References Tgstation.Server.Host.System.IAssemblyInformationProvider.VersionPrefix.
@@ -573,35 +580,35 @@ Here is the call graph for this function:Definition at line 92 of file ApplicationBuilderExtensions.cs.
-Definition at line 93 of file ApplicationBuilderExtensions.cs.
+References Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.GetLogger().
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation-members.html b/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation-members.html index 27abb85bce..d69e6d1516 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation-members.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutation-members.html @@ -81,7 +81,7 @@ $(function() {This is the complete list of members for Tgstation.Server.Host.GraphQL.Mutation, including all inherited members.
| GraphQLDescription | Tgstation.Server.Host.GraphQL.Mutation | static |
| Login([Service] IGraphQLAuthorityInvoker< ILoginAuthority > loginAuthority, CancellationToken cancellationToken) | Tgstation.Server.Host.GraphQL.Mutation | |
| Login([Service] IGraphQLAuthorityInvoker< ILoginAuthority > loginAuthority, CancellationToken cancellationToken) | Tgstation.Server.Host.GraphQL.Mutation |
Public Member Functions | |
| ValueTask< LoginPayload > | Login ([Service] IGraphQLAuthorityInvoker< ILoginAuthority > loginAuthority, CancellationToken cancellationToken) |
| Generate a JWT for authenticating with server. This is the only operation that accepts and required basic authentication. | |
| ValueTask< LoginResult > | Login ([Service] IGraphQLAuthorityInvoker< ILoginAuthority > loginAuthority, CancellationToken cancellationToken) |
| Generate a JWT for authenticating with server. This is the only operation that accepts and required basic authentication. | |
Static Public Attributes | |||||
| ValueTask< LoginPayload > Tgstation.Server.Host.GraphQL.Mutation.Login | +ValueTask< LoginResult > Tgstation.Server.Host.GraphQL.Mutation.Login | ( | [Service] IGraphQLAuthorityInvoker< ILoginAuthority > | loginAuthority, | @@ -153,10 +153,10 @@ Static Public Attributes|
Public Member Functions | |
| TokenResponse | ToApi () |
| TokenResponse | ToApi () |
Public Member Functions inherited from Tgstation.Server.Host.Models.ILegacyApiTransformable< TokenResponse > | |
| TApiModel | ToApi () |
| Convert the ILegacyApiTransformable<TApiModel> to it's TApiModel . | |
Properties | |
| required string | Bearer [get] |
| The JSON Web Token (JWT) to use as a Bearer token for accessing the server. Contains an expiry time. | |
| required Types.User | User [get] |
| The User that was logged in. | |
| required string | Bearer [get] |
| The JSON Web Token (JWT) to use as a Bearer token for accessing the server. Contains an expiry time. | |
| required Types.User | User [get] |
| The User that was logged in. | |
Success response for a login attempt.
-Definition at line 11 of file LoginPayload.cs.
+Definition at line 11 of file LoginResult.cs.
| TokenResponse Tgstation.Server.Host.GraphQL.Mutations.Payloads.LoginPayload.ToApi | +TokenResponse Tgstation.Server.Host.GraphQL.Mutations.Payloads.LoginResult.ToApi | ( | ) | @@ -145,18 +145,18 @@ Properties |
|
@@ -186,15 +186,15 @@ Here is the caller graph for this function:
|
@@ -215,13 +215,13 @@ Here is the caller graph for this function:
Files | |||||
| LoginPayload.cs | |||||
| LoginResult.cs | |||||
| PermissionSetInput.cs | |||||
| ►CTgstation.Server.Host.Models.ILegacyApiTransformable< RepositoryResponse > | |||||
| ►CTgstation.Server.Host.Models.ILegacyApiTransformable< TokenResponse > | |||||
| ►CTgstation.Server.Host.Models.ILegacyApiTransformable< UserGroupResponse > | |||||
| ►CTgstation.Server.Host.Models.ILegacyApiTransformable< UserResponse > | |||||
| |||||
| AttemptLogin(CancellationToken cancellationToken) | Tgstation.Server.Host.Authority.ILoginAuthority | |
| AttemptLogin(CancellationToken cancellationToken) | Tgstation.Server.Host.Authority.ILoginAuthority |
Public Member Functions | |
| ValueTask< AuthorityResponse< LoginPayload > > | AttemptLogin (CancellationToken cancellationToken) |
| Attempt to login to the server with the current crentials. | |
| ValueTask< AuthorityResponse< LoginResult > > | AttemptLogin (CancellationToken cancellationToken) |
| Attempt to login to the server with the current crentials. | |
IAuthority for authenticating with the server.
Definition at line 12 of file ILoginAuthority.cs.
| ValueTask< AuthorityResponse< LoginPayload > > Tgstation.Server.Host.Authority.ILoginAuthority.AttemptLogin | +ValueTask< AuthorityResponse< LoginResult > > Tgstation.Server.Host.Authority.ILoginAuthority.AttemptLogin | ( | CancellationToken | cancellationToken | ) | @@ -140,9 +140,9 @@ Public Member Functions
Implemented in Tgstation.Server.Host.Authority.LoginAuthority.
+Implemented in Tgstation.Server.Host.Authority.LoginAuthority.





Definition at line 25 of file IAssemblyInformationProvider.cs.
Referenced by Tgstation.Server.Host.Configuration.FileLoggingConfiguration.GetFullLogDirectory(), Tgstation.Server.Host.Extensions.IOManagerExtensions.GetPathInLocalDirectory(), and Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseServerBranding().
+Referenced by Tgstation.Server.Host.Configuration.FileLoggingConfiguration.GetFullLogDirectory(), Tgstation.Server.Host.Extensions.IOManagerExtensions.GetPathInLocalDirectory(), and Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseServerBranding().
diff --git a/namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads.html b/namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads.html index cbd9e78dbc..e2f96598bb 100644 --- a/namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads.html +++ b/namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_payloads.html @@ -82,8 +82,8 @@ $(function() {Classes | |
| class | LoginPayload |
| Success response for a login attempt. More... | |
| class | LoginResult |
| Success response for a login attempt. More... | |
| class | PermissionSetInput |
Updates a set of permissions for the server. null values default to their "None" variants. More... | |