Enum Class GlobalPermission

java.lang.Object
java.lang.Enum<GlobalPermission>
com.soulfiremc.grpc.generated.GlobalPermission
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<GlobalPermission>, Constable
@Generated public enum GlobalPermission extends Enum<GlobalPermission> implements com.google.protobuf.ProtocolMessageEnum
Server-wide permissions that apply globally across all instances.
These permissions control access to server administration, user management,
and self-service operations. Checked via the PermissionContext.global() method.
ADMIN role users have all global permissions by default.
Protobuf enum soulfire.v1.GlobalPermission

  • Enum Constant Details

    • CREATE_INSTANCE

      public static final GlobalPermission CREATE_INSTANCE
      Permission to create new SoulFire instances.
Required by InstanceService.CreateInstance RPC.
      CREATE_INSTANCE = 0;

    • GLOBAL_SUBSCRIBE_LOGS

      public static final GlobalPermission GLOBAL_SUBSCRIBE_LOGS
      Permission to subscribe to server-wide log streams.
Allows receiving logs from all instances and system components.
      GLOBAL_SUBSCRIBE_LOGS = 1;

    • READ_CLIENT_DATA

      public static final GlobalPermission READ_CLIENT_DATA
      Permission to read the authenticated user's own client data.
Required by ClientService.GetClientData RPC.
Returns user profile, permissions, and server information.
      READ_CLIENT_DATA = 2;

    • READ_SERVER_CONFIG

      public static final GlobalPermission READ_SERVER_CONFIG
      Permission to read the server configuration.
Required by ServerService.GetServerInfo RPC.
      READ_SERVER_CONFIG = 3;

    • UPDATE_SERVER_CONFIG

      public static final GlobalPermission UPDATE_SERVER_CONFIG
      Permission to modify the server configuration.
Required by ServerService.UpdateServerConfig and UpdateServerConfigEntry RPCs.
      UPDATE_SERVER_CONFIG = 4;

    • CREATE_USER

      public static final GlobalPermission CREATE_USER
      Permission to create new user accounts.
Required by UserService.CreateUser RPC.
      CREATE_USER = 5;

    • READ_USER

      public static final GlobalPermission READ_USER
      Permission to read information about other users.
Required by UserService.ListUsers and GetUserInfo RPCs.
      READ_USER = 6;

    • UPDATE_USER

      public static final GlobalPermission UPDATE_USER
      Permission to modify other users' accounts.
Required by UserService.UpdateUser RPC.
      UPDATE_USER = 7;

    • DELETE_USER

      public static final GlobalPermission DELETE_USER
      Permission to delete user accounts.
Required by UserService.DeleteUser RPC.
      DELETE_USER = 8;

    • GLOBAL_COMMAND_EXECUTION

      public static final GlobalPermission GLOBAL_COMMAND_EXECUTION
      Permission to execute commands at the global/server level.
Required by CommandService for server-wide command execution.
      GLOBAL_COMMAND_EXECUTION = 9;

    • INVALIDATE_SESSIONS

      public static final GlobalPermission INVALIDATE_SESSIONS
      Permission to invalidate sessions for other users.
Required by UserService.InvalidateSessions RPC.
Forces other users to re-authenticate.
      INVALIDATE_SESSIONS = 11;

    • GENERATE_SELF_WEBDAV_TOKEN

      public static final GlobalPermission GENERATE_SELF_WEBDAV_TOKEN
      Permission to generate a WebDAV authentication token for oneself.
Required by ClientService.GenerateWebDAVToken RPC.
WebDAV tokens provide file system access to instance data.
      GENERATE_SELF_WEBDAV_TOKEN = 12;

    • GENERATE_SELF_API_TOKEN

      public static final GlobalPermission GENERATE_SELF_API_TOKEN
      Permission to generate an API token for oneself.
Required by ClientService.GenerateAPIToken RPC.
API tokens can be used for programmatic access.
      GENERATE_SELF_API_TOKEN = 15;

    • UPDATE_SELF_USERNAME

      public static final GlobalPermission UPDATE_SELF_USERNAME
      Permission to update one's own username.
Required by ClientService.UpdateSelfUsername RPC.
      UPDATE_SELF_USERNAME = 13;

    • UPDATE_SELF_EMAIL

      public static final GlobalPermission UPDATE_SELF_EMAIL
      Permission to update one's own email address.
Required by ClientService.UpdateSelfEmail RPC.
      UPDATE_SELF_EMAIL = 14;

    • GENERATE_API_TOKEN

      public static final GlobalPermission GENERATE_API_TOKEN
      Permission to generate API tokens for other users.
Required by UserService.GenerateUserAPIToken RPC.
      GENERATE_API_TOKEN = 16;

    • INVALIDATE_SELF_SESSIONS

      public static final GlobalPermission INVALIDATE_SELF_SESSIONS
      Permission to invalidate one's own sessions.
Required by ClientService.InvalidateSelfSessions RPC.
Logs the user out of all devices.
      INVALIDATE_SELF_SESSIONS = 17;

    • UNRECOGNIZED

      public static final GlobalPermission UNRECOGNIZED

  • Field Details

    • CREATE_INSTANCE_VALUE

      public static final int CREATE_INSTANCE_VALUE
      Permission to create new SoulFire instances.
Required by InstanceService.CreateInstance RPC.
      CREATE_INSTANCE = 0;
      See Also:

    • GLOBAL_SUBSCRIBE_LOGS_VALUE

      public static final int GLOBAL_SUBSCRIBE_LOGS_VALUE
      Permission to subscribe to server-wide log streams.
Allows receiving logs from all instances and system components.
      GLOBAL_SUBSCRIBE_LOGS = 1;
      See Also:

    • READ_CLIENT_DATA_VALUE

      public static final int READ_CLIENT_DATA_VALUE
      Permission to read the authenticated user's own client data.
Required by ClientService.GetClientData RPC.
Returns user profile, permissions, and server information.
      READ_CLIENT_DATA = 2;
      See Also:

    • READ_SERVER_CONFIG_VALUE

      public static final int READ_SERVER_CONFIG_VALUE
      Permission to read the server configuration.
Required by ServerService.GetServerInfo RPC.
      READ_SERVER_CONFIG = 3;
      See Also:

    • UPDATE_SERVER_CONFIG_VALUE

      public static final int UPDATE_SERVER_CONFIG_VALUE
      Permission to modify the server configuration.
Required by ServerService.UpdateServerConfig and UpdateServerConfigEntry RPCs.
      UPDATE_SERVER_CONFIG = 4;
      See Also:

    • CREATE_USER_VALUE

      public static final int CREATE_USER_VALUE
      Permission to create new user accounts.
Required by UserService.CreateUser RPC.
      CREATE_USER = 5;
      See Also:

    • READ_USER_VALUE

      public static final int READ_USER_VALUE
      Permission to read information about other users.
Required by UserService.ListUsers and GetUserInfo RPCs.
      READ_USER = 6;
      See Also:

    • UPDATE_USER_VALUE

      public static final int UPDATE_USER_VALUE
      Permission to modify other users' accounts.
Required by UserService.UpdateUser RPC.
      UPDATE_USER = 7;
      See Also:

    • DELETE_USER_VALUE

      public static final int DELETE_USER_VALUE
      Permission to delete user accounts.
Required by UserService.DeleteUser RPC.
      DELETE_USER = 8;
      See Also:

    • GLOBAL_COMMAND_EXECUTION_VALUE

      public static final int GLOBAL_COMMAND_EXECUTION_VALUE
      Permission to execute commands at the global/server level.
Required by CommandService for server-wide command execution.
      GLOBAL_COMMAND_EXECUTION = 9;
      See Also:

    • INVALIDATE_SESSIONS_VALUE

      public static final int INVALIDATE_SESSIONS_VALUE
      Permission to invalidate sessions for other users.
Required by UserService.InvalidateSessions RPC.
Forces other users to re-authenticate.
      INVALIDATE_SESSIONS = 11;
      See Also:

    • GENERATE_SELF_WEBDAV_TOKEN_VALUE

      public static final int GENERATE_SELF_WEBDAV_TOKEN_VALUE
      Permission to generate a WebDAV authentication token for oneself.
Required by ClientService.GenerateWebDAVToken RPC.
WebDAV tokens provide file system access to instance data.
      GENERATE_SELF_WEBDAV_TOKEN = 12;
      See Also:

    • GENERATE_SELF_API_TOKEN_VALUE

      public static final int GENERATE_SELF_API_TOKEN_VALUE
      Permission to generate an API token for oneself.
Required by ClientService.GenerateAPIToken RPC.
API tokens can be used for programmatic access.
      GENERATE_SELF_API_TOKEN = 15;
      See Also:

    • UPDATE_SELF_USERNAME_VALUE

      public static final int UPDATE_SELF_USERNAME_VALUE
      Permission to update one's own username.
Required by ClientService.UpdateSelfUsername RPC.
      UPDATE_SELF_USERNAME = 13;
      See Also:

    • UPDATE_SELF_EMAIL_VALUE

      public static final int UPDATE_SELF_EMAIL_VALUE
      Permission to update one's own email address.
Required by ClientService.UpdateSelfEmail RPC.
      UPDATE_SELF_EMAIL = 14;
      See Also:

    • GENERATE_API_TOKEN_VALUE

      public static final int GENERATE_API_TOKEN_VALUE
      Permission to generate API tokens for other users.
Required by UserService.GenerateUserAPIToken RPC.
      GENERATE_API_TOKEN = 16;
      See Also:

    • INVALIDATE_SELF_SESSIONS_VALUE

      public static final int INVALIDATE_SELF_SESSIONS_VALUE
      Permission to invalidate one's own sessions.
Required by ClientService.InvalidateSelfSessions RPC.
Logs the user out of all devices.
      INVALIDATE_SELF_SESSIONS = 17;
      See Also:

  • Method Details

    • values

      public static GlobalPermission[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GlobalPermission valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static GlobalPermission valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static GlobalPermission forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<GlobalPermission> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static GlobalPermission valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null