Module iu.util.auth.config
Package edu.iu.auth.config

Enum Class IuAuthorizationClient.AuthMethod

java.lang.Object
java.lang.Enum<IuAuthorizationClient.AuthMethod>
edu.iu.auth.config.IuAuthorizationClient.AuthMethod
All Implemented Interfaces:
Serializable, Comparable<IuAuthorizationClient.AuthMethod>, Constable
Enclosing interface:
IuAuthorizationClient
public static enum IuAuthorizationClient.AuthMethod extends Enum<IuAuthorizationClient.AuthMethod>
Enumerate token endpoint authentication methods types.

  • Enum Constant Details

    • BASIC

      @Deprecated public static final IuAuthorizationClient.AuthMethod BASIC
      Deprecated.
      Most container standards require support for basic authentication, and Basic auth is supported by current HTTP standards. However, password authentication is insecure and should not be used in production. This IuAuthorizationClient.AuthMethod is useful for development and test environments and will be retained long term, but is deprecated to discourage direct use by enterprise applications.
      Direct use of client secret as password at API endpoint via Authorization Basic header.

    • BEARER

      public static final IuAuthorizationClient.AuthMethod BEARER
      Direct use of an access token via Authorization Bearer header.

    • CLIENT_SECRET_BASIC

      @Deprecated public static final IuAuthorizationClient.AuthMethod CLIENT_SECRET_BASIC
      Deprecated.
      OAuth 2.0 requires support for client_secret password, and Basic auth is supported by current HTTP standards. However, password authentication is insecure and should not be used in production. This IuAuthorizationClient.AuthMethod is useful for development and test environments and will be retained long term, but is deprecated to discourage direct use by enterprise applications.
      Bearer token w/ use of client secret as password at token endpoint via Authorization Basic header.

    • CLIENT_SECRET_POST

      @Deprecated public static final IuAuthorizationClient.AuthMethod CLIENT_SECRET_POST
      Deprecated.
      OAuth 2.0 requires support for client_secret POST. However, password authentication is insecure and should not be used in production. This IuAuthorizationClient.AuthMethod is useful for development and test environments and will be retained long term, but is deprecated to discourage direct use by enterprise applications.
      Bearer token w/ use of client secret as password at token endpoint via POST parameter.

    • CLIENT_SECRET_JWT

      public static final IuAuthorizationClient.AuthMethod CLIENT_SECRET_JWT
      Bearer token w/ use of client secret as HMAC key for signing a JWT assertion.

    • PRIVATE_KEY_JWT

      public static final IuAuthorizationClient.AuthMethod PRIVATE_KEY_JWT
      Bearer token w/ use of X509 certificate to demonstrate proof of private key possession via JWT assertion.

  • Field Details

    • JSON

      public static IuJsonAdapter<IuAuthorizationClient.AuthMethod> JSON
      JSON type adapter.

    • parameterValue

      public final String parameterValue
      Standard parameter value.

    • ttlPolicy

      public final Duration ttlPolicy
      Designates the minimum duration to allow for client configuration to expire with the auth method enabled.

    • requiresIpAllow

      public final boolean requiresIpAllow
      True if IP restrictions are required in order to use this authentication method.

  • Method Details

    • values

      public static IuAuthorizationClient.AuthMethod[] 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 IuAuthorizationClient.AuthMethod 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

    • from

      public static IuAuthorizationClient.AuthMethod from(String parameterValue)
      Gets an authentication method from standard parameter value.
      Parameters:
      parameterValue - standard parameter value
      Returns:
      IuAuthorizationClient.AuthMethod