Package com.buildless.authz

Enum Class PrivilegeLevel

java.lang.Object
java.lang.Enum<PrivilegeLevel>
com.buildless.authz.PrivilegeLevel
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<PrivilegeLevel>, Constable
public enum PrivilegeLevel extends Enum<PrivilegeLevel> implements com.google.protobuf.ProtocolMessageEnum
 ## Privilege Levels

 Specifies API-oriented privilege levels which map to generic permission levels, and which are mapped to users based
 on roles and rendered policies.
Protobuf enum buildless.authz.PrivilegeLevel

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADMIN
    Describes an API key which is fully privileged and should be kept secure and private.
    BILLING
    Describes an API key which is privileged to access billing records and settings, and to make payments on behalf of a customer or tenant account.
    PRIVILEGE_LEVEL_UNSPECIFIED
    Unspecified or unrecognized privilege level; this sentinel value is used when decoding an unrecognized enumeration case, such as a backwards-incompatible value.
    PUBLISHABLE
    Describes an API key which is safe to publish publicly on the internet, for example, on a public web-page, or in the README of a public source repository.
    READ_ONLY
    Describes an API key which is considered private and should be kept secure, but only grants read-only access to non-sensitive data within a given tenant or user account scope.
    READ_WRITE
    Describes an API key which is considered private and should be kept secure, and additionally allows non-sensitive write access (data, not settings).
    READ_WRITE_DELETE
    Describes an API key which is considered private and should be kept secure, and allows all privileges associated with `READ_WRITE`, plus destructive actions.
    TECH
    Describes an API key which is privileged to access tech or IT management functions, such as SCIM, SSO, and other sensitive settings.
    UNRECOGNIZED
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ADMIN_VALUE
    Describes an API key which is fully privileged and should be kept secure and private.
    static final int
    BILLING_VALUE
    Describes an API key which is privileged to access billing records and settings, and to make payments on behalf of a customer or tenant account.
    static final int
    PRIVILEGE_LEVEL_UNSPECIFIED_VALUE
    Unspecified or unrecognized privilege level; this sentinel value is used when decoding an unrecognized enumeration case, such as a backwards-incompatible value.
    static final int
    PUBLISHABLE_VALUE
    Describes an API key which is safe to publish publicly on the internet, for example, on a public web-page, or in the README of a public source repository.
    static final int
    READ_ONLY_VALUE
    Describes an API key which is considered private and should be kept secure, but only grants read-only access to non-sensitive data within a given tenant or user account scope.
    static final int
    READ_WRITE_DELETE_VALUE
    Describes an API key which is considered private and should be kept secure, and allows all privileges associated with `READ_WRITE`, plus destructive actions.
    static final int
    READ_WRITE_VALUE
    Describes an API key which is considered private and should be kept secure, and additionally allows non-sensitive write access (data, not settings).
    static final int
    TECH_VALUE
    Describes an API key which is privileged to access tech or IT management functions, such as SCIM, SSO, and other sensitive settings.

  • Method Summary

    Modifier and Type
    Method
    Description
    static PrivilegeLevel
    forNumber(int value)
     
    static final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptor()
     
    final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptorForType()
     
    final int
    getNumber()
     
    final com.google.protobuf.Descriptors.EnumValueDescriptor
    getValueDescriptor()
     
    static com.google.protobuf.Internal.EnumLiteMap<PrivilegeLevel>
    internalGetValueMap()
     
    static PrivilegeLevel
    valueOf(int value)
    Deprecated.
    static PrivilegeLevel
    valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
    Returns the enum constant of this class with the specified name.
    static PrivilegeLevel
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PrivilegeLevel[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PRIVILEGE_LEVEL_UNSPECIFIED

      public static final PrivilegeLevel PRIVILEGE_LEVEL_UNSPECIFIED
       Unspecified or unrecognized privilege level; this sentinel value is used when decoding an unrecognized enumeration
 case, such as a backwards-incompatible value. Regular application code should not use this.
      PRIVILEGE_LEVEL_UNSPECIFIED = 0;

    • PUBLISHABLE

      public static final PrivilegeLevel PUBLISHABLE
       Describes an API key which is safe to publish publicly on the internet, for example, on a public web-page, or in
 the README of a public source repository.
      PUBLISHABLE = 1;

    • READ_ONLY

      public static final PrivilegeLevel READ_ONLY
       Describes an API key which is considered private and should be kept secure, but only grants read-only access to
 non-sensitive data within a given tenant or user account scope.
      READ_ONLY = 20;

    • READ_WRITE

      public static final PrivilegeLevel READ_WRITE
       Describes an API key which is considered private and should be kept secure, and additionally allows non-sensitive
 write access (data, not settings).
      READ_WRITE = 30;

    • READ_WRITE_DELETE

      public static final PrivilegeLevel READ_WRITE_DELETE
       Describes an API key which is considered private and should be kept secure, and allows all privileges associated
 with `READ_WRITE`, plus destructive actions.
      READ_WRITE_DELETE = 40;

    • BILLING

      public static final PrivilegeLevel BILLING
       Describes an API key which is privileged to access billing records and settings, and to make payments on behalf of
 a customer or tenant account.
      BILLING = 75;

    • TECH

      public static final PrivilegeLevel TECH
       Describes an API key which is privileged to access tech or IT management functions, such as SCIM, SSO, and other
 sensitive settings.
      TECH = 80;

    • ADMIN

      public static final PrivilegeLevel ADMIN
       Describes an API key which is fully privileged and should be kept secure and private. This key can perform any
 action via the API on behalf of a given user or tenant account.
      ADMIN = 99;

    • UNRECOGNIZED

      public static final PrivilegeLevel UNRECOGNIZED

  • Field Details

    • PRIVILEGE_LEVEL_UNSPECIFIED_VALUE

      public static final int PRIVILEGE_LEVEL_UNSPECIFIED_VALUE
       Unspecified or unrecognized privilege level; this sentinel value is used when decoding an unrecognized enumeration
 case, such as a backwards-incompatible value. Regular application code should not use this.
      PRIVILEGE_LEVEL_UNSPECIFIED = 0;
      See Also:

    • PUBLISHABLE_VALUE

      public static final int PUBLISHABLE_VALUE
       Describes an API key which is safe to publish publicly on the internet, for example, on a public web-page, or in
 the README of a public source repository.
      PUBLISHABLE = 1;
      See Also:

    • READ_ONLY_VALUE

      public static final int READ_ONLY_VALUE
       Describes an API key which is considered private and should be kept secure, but only grants read-only access to
 non-sensitive data within a given tenant or user account scope.
      READ_ONLY = 20;
      See Also:

    • READ_WRITE_VALUE

      public static final int READ_WRITE_VALUE
       Describes an API key which is considered private and should be kept secure, and additionally allows non-sensitive
 write access (data, not settings).
      READ_WRITE = 30;
      See Also:

    • READ_WRITE_DELETE_VALUE

      public static final int READ_WRITE_DELETE_VALUE
       Describes an API key which is considered private and should be kept secure, and allows all privileges associated
 with `READ_WRITE`, plus destructive actions.
      READ_WRITE_DELETE = 40;
      See Also:

    • BILLING_VALUE

      public static final int BILLING_VALUE
       Describes an API key which is privileged to access billing records and settings, and to make payments on behalf of
 a customer or tenant account.
      BILLING = 75;
      See Also:

    • TECH_VALUE

      public static final int TECH_VALUE
       Describes an API key which is privileged to access tech or IT management functions, such as SCIM, SSO, and other
 sensitive settings.
      TECH = 80;
      See Also:

    • ADMIN_VALUE

      public static final int ADMIN_VALUE
       Describes an API key which is fully privileged and should be kept secure and private. This key can perform any
 action via the API on behalf of a given user or tenant account.
      ADMIN = 99;
      See Also:

  • Method Details

    • values

      public static PrivilegeLevel[] 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 PrivilegeLevel 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 PrivilegeLevel 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 PrivilegeLevel 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<PrivilegeLevel> 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static PrivilegeLevel 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