Enum Class Auth

All Implemented Interfaces:
Serializable, Comparable<Auth>, Constable

public enum Auth extends Enum<Auth>
Enum used to configure authentication settings for Actions.
  • Enum Constant Details


      public static final Auth AUTH_PUBLIC
      Allows anyone to access.

      This is used for public HTML endpoints like RDAP, the check API, and web WHOIS.


      public static final Auth AUTH_PUBLIC_LOGGED_IN
      Allows anyone to access, as long as they are logged in.

      Note that the action might use AuthenticatedRegistrarAccessor to impose a more fine-grained access control pattern than merely whether the user is logged in/out.


      public static final Auth AUTH_ADMIN
      Allows only the app itself (via service accounts) or admins to access.

      This applies to the majority of the endpoints. For APP level authentication to work, the associated service account needs to be allowlisted in the auth.allowedServiceAccountEmails field in the config YAML file.

  • Method Details

    • values

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

      public static Auth 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.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • authSettings

      public AuthSettings authSettings()