Package com.buildless.api

Enum Class AuthorizationMode

java.lang.Object
java.lang.Enum<AuthorizationMode>
com.buildless.api.AuthorizationMode
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<AuthorizationMode>, Constable
public enum AuthorizationMode extends Enum<AuthorizationMode> implements com.google.protobuf.ProtocolMessageEnum
 ## Authorization Mode

 This enumeration describes each available mode for Buildless API authorization. API methods can be specialized for
 end-users or tenant accounts only, in which case they are annotated with the applicable mode.

 By default, `AUTHORIZATION_DEFAULT` is set on each method, which allows any valid authorization credentials,
 regardless of credential type.
Protobuf enum buildless.api.AuthorizationMode

  • Enum Constant Details

    • AUTHORIZATION_DEFAULT

      public static final AuthorizationMode AUTHORIZATION_DEFAULT
       Allow all Buildless credentials, regardless of credential type. This includes both org-level ("tenant") credentials
 as well as end-user credentials. If the operation is marked as "sensitive," additional credentials may be required.
      AUTHORIZATION_DEFAULT = 0;

    • USERS_ONLY

      public static final AuthorizationMode USERS_ONLY
       Allow end-users only. In this mode, either an end-user's valid API key must be present, or a valid authorization
 token or session token must be present on the request. If the operation is marked as "sensitive," additional
 credentials may be required.
      USERS_ONLY = 1;

    • TENANTS_ONLY

      public static final AuthorizationMode TENANTS_ONLY
       Allow tenant organizations only. In this mode, an organization-level API key must be present on the request. If
 the method is marked as "sensitive," additional credentials may be required. In this mode, a tenant ID is always
 expected to be declared.
      TENANTS_ONLY = 2;

    • UNRECOGNIZED

      public static final AuthorizationMode UNRECOGNIZED

  • Field Details

    • AUTHORIZATION_DEFAULT_VALUE

      public static final int AUTHORIZATION_DEFAULT_VALUE
       Allow all Buildless credentials, regardless of credential type. This includes both org-level ("tenant") credentials
 as well as end-user credentials. If the operation is marked as "sensitive," additional credentials may be required.
      AUTHORIZATION_DEFAULT = 0;
      See Also:

    • USERS_ONLY_VALUE

      public static final int USERS_ONLY_VALUE
       Allow end-users only. In this mode, either an end-user's valid API key must be present, or a valid authorization
 token or session token must be present on the request. If the operation is marked as "sensitive," additional
 credentials may be required.
      USERS_ONLY = 1;
      See Also:

    • TENANTS_ONLY_VALUE

      public static final int TENANTS_ONLY_VALUE
       Allow tenant organizations only. In this mode, an organization-level API key must be present on the request. If
 the method is marked as "sensitive," additional credentials may be required. In this mode, a tenant ID is always
 expected to be declared.
      TENANTS_ONLY = 2;
      See Also:

  • Method Details

    • values

      public static AuthorizationMode[] 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 AuthorizationMode 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 AuthorizationMode 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 AuthorizationMode 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<AuthorizationMode> 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 AuthorizationMode 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