Package com.atlassian.oauth2.provider.api.token

Enum Class FlowType

java.lang.Object
java.lang.Enum<FlowType>
com.atlassian.oauth2.provider.api.token.FlowType
All Implemented Interfaces:
Serializable, Comparable<FlowType>, Constable
public enum FlowType extends Enum<FlowType>
Enum to represent the different types of OAuth2 flows supported by the provider
Since:
3.1.14

  • Enum Constant Details

    • PKCE

      public static final FlowType PKCE
      PKCE is an extension to the Authorization Code flow to prevent CSRF and authorization code injection attacks.

    • AUTHORIZATION_CODE

      public static final FlowType AUTHORIZATION_CODE
      The Authorization Code grant type is designed to acquire access tokens and refresh tokens. Being a redirection-based process, it requires the client to interact with the resource owner's user-agent, usually a web browser, and to accept incoming requests redirected from the authorization server.

    • CLIENT_CREDENTIALS

      public static final FlowType CLIENT_CREDENTIALS
      The Client Credentials grant type is suitable for machine-to-machine authentication. It is used to request an access token using only the client credentials, without any user authentication.
      Since:
      4.2.0

    • REFRESH_TOKEN

      public static final FlowType REFRESH_TOKEN
      The Refresh Token grant type is used to obtain a new access token by using a refresh token. This is useful when the access token has expired and the client needs to obtain a new one without requiring user interaction.
      Since:
      5.0.0

  • Field Details

    • PUBLIC_FLOWS

      public static final Set<FlowType> PUBLIC_FLOWS
      Flows that do not require a client secret

  • Method Details

    • values

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

    • fromIdentifier

      public static FlowType fromIdentifier(@Nullable String identifier)

    • getFlowIdentifier

      public String getFlowIdentifier()

    • isClientCredentials

      @Deprecated(forRemoval=true) public static boolean isClientCredentials(String flowIdentifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
      will be removed in the 6.x major version.