Tgstation.Server.Api.Rights Namespace Reference

Classes
class	RightsHelper
	Helper for RightsTypes. More...

Enumerations
enum	AdministrationRights : ulong {   None = 0 , WriteUsers = 1 << 0 , RestartHost = 1 << 1 , ChangeVersion = 1 << 2 ,   EditOwnPassword = 1 << 3 , ReadUsers = 1 << 4 , DownloadLogs = 1 << 5 , EditOwnOAuthConnections = 1 << 6 ,   UploadVersion = 1 << 7 }
	Administration rights for the server. More...
enum	ChatBotRights : ulong {   None = 0 , WriteEnabled = 1 << 0 , WriteProvider = 1 << 1 , WriteChannels = 1 << 2 ,   WriteConnectionString = 1 << 3 , ReadConnectionString = 1 << 4 , Read = 1 << 5 , Create = 1 << 6 ,   Delete = 1 << 7 , WriteName = 1 << 8 , WriteReconnectionInterval = 1 << 9 , WriteChannelLimit = 1 << 10 }
	Rights for chat bots. More...
enum	ConfigurationRights : ulong {   None = 0 , Read = 1 << 0 , Write = 1 << 1 , List = 1 << 2 ,   Delete = 1 << 3 }
	Rights for Models.IConfigurationFiles. More...
enum	DreamDaemonRights : ulong {   None = 0 , ReadRevision = 1 << 0 , SetPort = 1 << 1 , SetAutoStart = 1 << 2 ,   SetSecurity = 1 << 3 , ReadMetadata = 1 << 4 , SetWebClient = 1 << 5 , SoftRestart = 1 << 6 ,   SoftShutdown = 1 << 7 , Restart = 1 << 8 , Shutdown = 1 << 9 , Start = 1 << 10 ,   SetStartupTimeout = 1 << 11 , SetHealthCheckInterval = 1 << 12 , CreateDump = 1 << 13 , SetTopicTimeout = 1 << 14 ,   SetAdditionalParameters = 1 << 15 , SetVisibility = 1 << 16 , SetProfiler = 1 << 17 , SetLogOutput = 1 << 18 ,   SetMapThreads = 1 << 19 , BroadcastMessage = 1 << 20 , SetMinidumps = 1 << 21 }
	Rights for managing DreamDaemon. More...
enum	DreamMakerRights : ulong {   None = 0 , Read = 1 << 0 , Compile = 1 << 1 , CancelCompile = 1 << 2 ,   SetDme = 1 << 3 , SetApiValidationPort = 1 << 4 , CompileJobs = 1 << 5 , SetSecurityLevel = 1 << 6 ,   SetApiValidationRequirement = 1 << 7 , SetTimeout = 1 << 8 , SetCompilerArguments = 1 << 9 }
	Rights for deployment. More...
enum	EngineRights : ulong {   None = 0 , ReadActive = 1 << 0 , ListInstalled = 1 << 1 , InstallOfficialOrChangeActiveByondVersion = 1 << 2 ,   CancelInstall = 1 << 3 , InstallCustomByondVersion = 1 << 4 , DeleteInstall = 1 << 5 , InstallOfficialOrChangeActiveOpenDreamVersion = 1 << 6 ,   InstallCustomOpenDreamVersion = 1 << 7 }
	Rights for engine version management. More...
enum	InstanceManagerRights : ulong {   None = 0 , Read = 1 << 0 , Create = 1 << 1 , Rename = 1 << 2 ,   Relocate = 1 << 3 , SetOnline = 1 << 4 , Delete = 1 << 5 , List = 1 << 6 ,   SetConfiguration = 1 << 7 , SetAutoUpdate = 1 << 8 , SetChatBotLimit = 1 << 9 , GrantPermissions = 1 << 10 ,   SetAutoStart = 1 << 11 , SetAutoStop = 1 << 12 }
	Rights for managing Models.Instances. More...
enum	InstancePermissionSetRights : ulong { None = 0 , Read = 1 << 0 , Write = 1 << 1 , Create = 1 << 2 }
	Rights for an Models.Instance. More...
enum	RepositoryRights : ulong {   None = 0 , CancelPendingChanges = 1 << 0 , SetOrigin = 1 << 1 , SetSha = 1 << 2 ,   MergePullRequest = 1 << 3 , UpdateBranch = 1 << 4 , ChangeCommitter = 1 << 5 , ChangeTestMergeCommits = 1 << 6 ,   ChangeCredentials = 1 << 7 , SetReference = 1 << 8 , Read = 1 << 9 , ChangeAutoUpdateSettings = 1 << 10 ,   Delete = 1 << 11 , CancelClone = 1 << 12 , ChangeSubmoduleUpdate = 1 << 13 , Reclone = 1 << 14 }
	Rights for the git repository. More...
enum	RightsType : ulong {   Administration , InstanceManager , Repository , Engine ,   DreamMaker , DreamDaemon , ChatBots , Configuration ,   InstancePermissionSet }
	The type of rights a model uses. More...

Enumeration Type Documentation

AdministrationRights

enum Tgstation.Server.Api.Rights.AdministrationRights : ulong

Administration rights for the server.

Enumerator
None	User has no rights.
WriteUsers	User has complete control over creating/editing Models.Response.UserResponses and Models.Response.UserGroupResponses (and deleting in the case of the latter).
RestartHost	User can gracefully restart TGS.
ChangeVersion	User can read Models.Response.AdministrationResponse and upgrade/downgrade TGS using GitHub through the API.
EditOwnPassword	User can change their password.
ReadUsers	User can read info and rights of other users.
DownloadLogs	User can list and download Models.Response.LogFileResponses.
EditOwnOAuthConnections	User can modify their own Models.Internal.UserApiBase.OAuthConnections.
UploadVersion	User can upgrade/downgrade TGS using file uploads through the API.

Definition at line 9 of file AdministrationRights.cs.

    {
        None = 0,
 
        WriteUsers = 1 << 0,
 
        RestartHost = 1 << 1,
 
        ChangeVersion = 1 << 2,
 
        EditOwnPassword = 1 << 3,
 
        ReadUsers = 1 << 4,
 
        DownloadLogs = 1 << 5,
 
        EditOwnOAuthConnections = 1 << 6,
 
        UploadVersion = 1 << 7,
    }

ChatBotRights

enum Tgstation.Server.Api.Rights.ChatBotRights : ulong

Rights for chat bots.

Enumerator
None	User has no rights.
WriteEnabled	User can change Models.Internal.ChatBotSettings.Enabled.
WriteProvider	User can change Models.Internal.ChatBotSettings.Provider.
WriteChannels	User can change Models.Internal.ChatBotApiBase.Channels.
WriteConnectionString	User can change Models.Internal.ChatBotSettings.ConnectionString.
ReadConnectionString	User can read Models.Internal.ChatBotSettings.ConnectionString requires the Read permission.
Read	User can read all chat bot properties except Models.Internal.ChatBotSettings.ConnectionString.
Create	User can create new chat bots.
Delete	User can delete chat bots.
WriteName	User can change Models.NamedEntity.Name.
WriteReconnectionInterval	User can change Models.Internal.ChatBotSettings.ReconnectionInterval.
WriteChannelLimit	User can change Models.Internal.ChatBotSettings.ChannelLimit.

Definition at line 9 of file ChatBotRights.cs.

    {
        None = 0,
 
        WriteEnabled = 1 << 0,
 
        WriteProvider = 1 << 1,
 
        WriteChannels = 1 << 2,
 
        WriteConnectionString = 1 << 3,
 
        ReadConnectionString = 1 << 4,
 
        Read = 1 << 5,
 
        Create = 1 << 6,
 
        Delete = 1 << 7,
 
        WriteName = 1 << 8,
 
        WriteReconnectionInterval = 1 << 9,
 
        WriteChannelLimit = 1 << 10,
    }

ConfigurationRights

enum Tgstation.Server.Api.Rights.ConfigurationRights : ulong

Rights for Models.IConfigurationFiles.

Enumerator
None	User has no rights.
Read	User may read files if the Models.Instance allows it.
Write	User may write files if the Models.Instance allows it.
List	User may list files if the Models.Instance allows it.
Delete	User may delete empty folders if the Models.Instance allows it.

Definition at line 9 of file ConfigurationRights.cs.

    {
        None = 0,
 
        Read = 1 << 0,
 
        Write = 1 << 1,
 
        List = 1 << 2,
 
        Delete = 1 << 3,
    }

DreamDaemonRights

enum Tgstation.Server.Api.Rights.DreamDaemonRights : ulong

Rights for managing DreamDaemon.

Enumerator
None	User has no rights.
ReadRevision	User can read Models.Response.DreamDaemonResponse.ActiveCompileJob and Models.Response.DreamDaemonResponse.StagedCompileJob.
SetPort	User can change the port DreamDaemon runs on.
SetAutoStart	User can change Models.Internal.DreamDaemonSettings.AutoStart.
SetSecurity	User set Models.Internal.DreamDaemonLaunchParameters.SecurityLevel.
ReadMetadata	User can read every property of Models.Response.DreamDaemonResponse except Models.Response.DreamDaemonResponse.ActiveCompileJob and Models.Response.DreamDaemonResponse.StagedCompileJob.
SetWebClient	User can change Models.Internal.DreamDaemonLaunchParameters.AllowWebClient.
SoftRestart	User can change Models.Internal.DreamDaemonApiBase.SoftRestart.
SoftShutdown	User can change Models.Internal.DreamDaemonApiBase.SoftShutdown.
Restart	User can immediately restart the Watchdog.
Shutdown	User can immediately shutdown the Watchdog.
Start	User can start the Watchdog.
SetStartupTimeout	User can change Models.Internal.DreamDaemonLaunchParameters.StartupTimeout.
SetHealthCheckInterval	User can change Models.Internal.DreamDaemonLaunchParameters.HealthCheckSeconds.
CreateDump	User can create DreamDaemon process dumps or change Models.Internal.DreamDaemonLaunchParameters.DumpOnHealthCheckRestart.
SetTopicTimeout	User can change Models.Internal.DreamDaemonLaunchParameters.TopicRequestTimeout.
SetAdditionalParameters	User can change Models.Internal.DreamDaemonLaunchParameters.AdditionalParameters.
SetVisibility	User can change Models.Internal.DreamDaemonLaunchParameters.Visibility.
SetProfiler	User can change Models.Internal.DreamDaemonLaunchParameters.StartProfiler.
SetLogOutput	User can change Models.Internal.DreamDaemonLaunchParameters.LogOutput.
SetMapThreads	User can change Models.Internal.DreamDaemonLaunchParameters.MapThreads.
BroadcastMessage	User can use Models.Request.DreamDaemonRequest.BroadcastMessage.
SetMinidumps	User can use Models.Internal.DreamDaemonLaunchParameters.Minidumps.

Definition at line 9 of file DreamDaemonRights.cs.

    {
        None = 0,
 
        ReadRevision = 1 << 0,
 
        SetPort = 1 << 1,
 
        SetAutoStart = 1 << 2,
 
        SetSecurity = 1 << 3,
 
        ReadMetadata = 1 << 4,
 
        SetWebClient = 1 << 5,
 
        SoftRestart = 1 << 6,
 
        SoftShutdown = 1 << 7,
 
        Restart = 1 << 8,
 
        Shutdown = 1 << 9,
 
        Start = 1 << 10,
 
        SetStartupTimeout = 1 << 11,
 
        SetHealthCheckInterval = 1 << 12,
 
        CreateDump = 1 << 13,
 
        SetTopicTimeout = 1 << 14,
 
        SetAdditionalParameters = 1 << 15,
 
        SetVisibility = 1 << 16,
 
        SetProfiler = 1 << 17,
 
        SetLogOutput = 1 << 18,
 
        SetMapThreads = 1 << 19,
 
        BroadcastMessage = 1 << 20,
 
        SetMinidumps = 1 << 21,
    }

DreamMakerRights

enum Tgstation.Server.Api.Rights.DreamMakerRights : ulong

Rights for deployment.

Enumerator
None	User has no rights.
Read	User may read all properties of Models.Internal.DreamMakerSettings.
Compile	User may trigger deployments.
CancelCompile	User may cancel deployment jobs.
SetDme	User may modify Models.Internal.DreamMakerSettings.ProjectName.
SetApiValidationPort	User may modify Models.Internal.DreamMakerSettings.ApiValidationPort.
CompileJobs	User may list and read all Models.Internal.CompileJobs.
SetSecurityLevel	User may modify Models.Internal.DreamMakerSettings.ApiValidationSecurityLevel.
SetApiValidationRequirement	User may modify Models.Internal.DreamMakerSettings.DMApiValidationMode and Models.Internal.DreamMakerSettings.RequireDMApiValidation.
SetTimeout	User may modify Models.Internal.DreamMakerSettings.Timeout.
SetCompilerArguments	User may modify Models.Internal.DreamMakerSettings.CompilerAdditionalArguments.

Definition at line 9 of file DreamMakerRights.cs.

    {
        None = 0,
 
        Read = 1 << 0,
 
        Compile = 1 << 1,
 
        CancelCompile = 1 << 2,
 
        SetDme = 1 << 3,
 
        SetApiValidationPort = 1 << 4,
 
        CompileJobs = 1 << 5,
 
        SetSecurityLevel = 1 << 6,
 
        SetApiValidationRequirement = 1 << 7,
 
        SetTimeout = 1 << 8,
 
        SetCompilerArguments = 1 << 9,
    }

EngineRights

enum Tgstation.Server.Api.Rights.EngineRights : ulong

Rights for engine version management.

Enumerator
None	User has no rights.
ReadActive	User may view the active installed engine versions.
ListInstalled	User may list all installed engine versions.
InstallOfficialOrChangeActiveByondVersion	User may install official Models.EngineType.Byond versions or change the active Models.EngineType.Byond version.
CancelInstall	User may cancel an engine installation job.
InstallCustomByondVersion	User may upload and activate custom Models.EngineType.Byond builds.
DeleteInstall	User may delete non-active engine builds.
InstallOfficialOrChangeActiveOpenDreamVersion	User may install official Models.EngineType.OpenDream versions or change the active Models.EngineType.OpenDream version.
InstallCustomOpenDreamVersion	User may activate custom Models.EngineType.OpenDream builds via zip upload or custom git committish.

Definition at line 9 of file EngineRights.cs.

    {
        None = 0,
 
        ReadActive = 1 << 0,
 
        ListInstalled = 1 << 1,
 
        InstallOfficialOrChangeActiveByondVersion = 1 << 2,
 
        CancelInstall = 1 << 3,
 
        InstallCustomByondVersion = 1 << 4,
 
        DeleteInstall = 1 << 5,
 
        InstallOfficialOrChangeActiveOpenDreamVersion = 1 << 6,
 
        InstallCustomOpenDreamVersion = 1 << 7,
    }

InstanceManagerRights

enum Tgstation.Server.Api.Rights.InstanceManagerRights : ulong

Rights for managing Models.Instances.

Enumerator
None	User has no rights.
Read	User can view Models.Instances which they have an Models.Internal.InstancePermissionSet for.
Create	User can create Models.Instances.
Rename	User can rename Models.Instances they can view.
Relocate	User can relocate Models.Instances they can view.
SetOnline	User can online Models.Instances they can view.
Delete	User can delete Models.Instances they can view.
List	User can view all Models.Instances.
SetConfiguration	User can change Models.Instance.ConfigurationType on instances they can view.
SetAutoUpdate	User can change Models.Instance.AutoUpdateInterval on instances they can view.
SetChatBotLimit	User can change Models.Instance.ChatBotLimit on instances they can view.
GrantPermissions	User can give themselves or their group full InstancePermissionSetRights on ALL instances.
SetAutoStart	User can change Models.Instance.AutoStartCron.
SetAutoStop	User can change Models.Instance.AutoStopCron.

Definition at line 9 of file InstanceManagerRights.cs.

    {
        None = 0,
 
        Read = 1 << 0,
 
        Create = 1 << 1,
 
        Rename = 1 << 2,
 
        Relocate = 1 << 3,
 
        SetOnline = 1 << 4,
 
        Delete = 1 << 5,
 
        List = 1 << 6,
 
        SetConfiguration = 1 << 7,
 
        SetAutoUpdate = 1 << 8,
 
        SetChatBotLimit = 1 << 9,
 
        GrantPermissions = 1 << 10,
 
        SetAutoStart = 1 << 11,
 
        SetAutoStop = 1 << 12,
    }

InstancePermissionSetRights

enum Tgstation.Server.Api.Rights.InstancePermissionSetRights : ulong

Rights for an Models.Instance.

Enumerator
None	User has no rights.
Read	Allow read access to all Models.Internal.InstancePermissionSets in the Models.Instance.
Write	Allow write and delete access to all Models.Internal.InstancePermissionSet for the Models.Instance.
Create	Allow adding additional Models.Internal.InstancePermissionSets to the Models.Instance.

Definition at line 9 of file InstancePermissionSetRights.cs.

    {
        None = 0,
 
        Read = 1 << 0,
 
        Write = 1 << 1,
 
        Create = 1 << 2,
    }

RepositoryRights

enum Tgstation.Server.Api.Rights.RepositoryRights : ulong

Rights for the git repository.

Enumerator
None	User has no rights.
CancelPendingChanges	User may cancel repository jobs excluding clone operations.
SetOrigin	User may clone the repository if it does not exist. This also allows setting Models.RepositorySettings.UpdateSubmodules, Models.RepositorySettings.AccessUser, and Models.RepositorySettings.AccessToken at clone time.
SetSha	User may directly checkout a git SHA that the repository's HEAD will point to.
MergePullRequest	User may create Models.TestMerges.
UpdateBranch	User may fetch and hard reset to the origin version of the current branch.
ChangeCommitter	User may change Models.RepositorySettings.CommitterName and Models.RepositorySettings.CommitterEmail.
ChangeTestMergeCommits	User may change Models.RepositorySettings.PushTestMergeCommits, Models.RepositorySettings.PostTestMergeComment, and Models.RepositorySettings.CreateGitHubDeployments.
ChangeCredentials	User may read and change Models.RepositorySettings.AccessUser and Models.RepositorySettings.AccessToken.
SetReference	User may set Models.Internal.RepositoryApiBase.Reference to another git branch or tag (not a SHA).
Read	User may read repository information.
ChangeAutoUpdateSettings	User may change Models.RepositorySettings.AutoUpdatesKeepTestMerges and Models.RepositorySettings.AutoUpdatesSynchronize.
Delete	User may delete the repository and allow it to be cloned again.
CancelClone	User may cancel clone jobs.
ChangeSubmoduleUpdate	User may change submodule update settings.
Reclone	User may trigger repository recloning.

Definition at line 9 of file RepositoryRights.cs.

    {
        None = 0,
 
        CancelPendingChanges = 1 << 0,
 
        SetOrigin = 1 << 1,
 
        SetSha = 1 << 2,
 
        MergePullRequest = 1 << 3,
 
        UpdateBranch = 1 << 4,
 
        ChangeCommitter = 1 << 5,
 
        ChangeTestMergeCommits = 1 << 6,
 
        ChangeCredentials = 1 << 7,
 
        SetReference = 1 << 8,
 
        Read = 1 << 9,
 
        ChangeAutoUpdateSettings = 1 << 10,
 
        Delete = 1 << 11,
 
        CancelClone = 1 << 12,
 
        ChangeSubmoduleUpdate = 1 << 13,
 
        Reclone = 1 << 14,
    }

RightsType

enum Tgstation.Server.Api.Rights.RightsType : ulong

The type of rights a model uses.

Enumerator
Administration	AdministrationRights.
InstanceManager	InstanceManagerRights.
Repository	RepositoryRights.
Engine	EngineRights.
DreamMaker	DreamMakerRights.
DreamDaemon	DreamDaemonRights.
ChatBots	ChatBotRights.
Configuration	ConfigurationRights.
InstancePermissionSet	InstancePermissionSetRights.

Definition at line 6 of file RightsType.cs.

    {
        Administration,
 
        InstanceManager,
 
        Repository,
 
        Engine,
 
        DreamMaker,
 
        DreamDaemon,
 
        ChatBots,
 
        Configuration,
 
        InstancePermissionSet,
    }