Module org.refcodes.web
Package org.refcodes.web

Enum Class GrantType

java.lang.Object
java.lang.Enum<GrantType>
org.refcodes.web.GrantType
All Implemented Interfaces:
Serializable, Comparable<GrantType>, Constable, org.refcodes.mixin.ValueAccessor<String>
public enum GrantType extends Enum<GrantType> implements org.refcodes.mixin.ValueAccessor<String>
The GrantType enumerations. See also: https://auth0.com/docs/get-started/applications/application-grant-types https://fusionauth.io/learn/expert-advice/oauth/complete-list-oauth-grants

  • Nested Class Summary

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

    Enum.EnumDesc<E extends Enum<E>>

    Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor

    org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends Object>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AUTH0_LEGACY_ACCESS_TOKEN
    Use legacy Access Token "http://auth0.com/oauth/legacy/grant-type/access_token" Grant (Auth0 legacy grant).
    AUTH0_LEGACY_DELEGATION_ID_TOKEN
    Use legacy ID Token "http://auth0.com/oauth/legacy/grant-type/delegation/id_token" Grant (Auth0 legacy grant).
    AUTH0_LEGACY_DELEGATION_REFRESH_TOKEN
    Use Legacy Refresh Tokens "http://auth0.com/oauth/legacy/grant-type/delegation/refresh_token" Grant (Auth0 legacy grant).
    AUTH0_LEGACY_RO
    Use legacy RO "http://auth0.com/oauth/legacy/grant-type/ro" Grant (Auth0 legacy grant).
    AUTH0_LEGACY_RO_JWT_BEARER
    Use legacy JWT-Bearer "http://auth0.com/oauth/legacy/grant-type/ro/jwt-bearer" Grant (Auth0 legacy grant).
    AUTH0_MFA_OOB
    Multi-factor Authentication OOB "http://auth0.com/oauth/grant-type/mfa-oob" Grant Request (Auth0 extension grant).
    AUTH0_MFA_OTP
    Multi-factor Authentication OTP "http://auth0.com/oauth/grant-type/mfa-otp" Grant Request (Auth0 extension grant).
    AUTH0_MFA_RECOVERY_CODE
    Multi-factor Authentication Recovery "http://auth0.com/oauth/grant-type/mfa-recovery-code" Grant Request (Auth0 extension grant).
    AUTH0_PASSWORD_REALM
    Use an extension grant "http://auth0.com/oauth/grant-type/password-realm" similar to the Resource Owner Password Grant that includes the ability to indicate a specific realm (Auth0 extension grant).
    AUTH0_PASSWORDLESS_OTP
    Embedded Passwordless Login "http://auth0.com/oauth/grant-type/passwordless/otp" Grant Request (Auth0 extension grant).
    AUTHORIZATION_CODE
    Authorization Code "authorization_code" Grant (specification conforming grant).
    CLIENT_CREDENTIALS
    Client Credentials "client_credentials" Grant (specification conforming grant).
    DEVICE_CODE
    Device Authorization "urn:ietf:params:oauth:grant-type:device_code" Grant (specification conforming grant).
    IMPLICIT
    Implicit "implicit" Grant (specification conforming grant).
    JWT_BEARER
    Use JWT Bearer (JWT Bearer "urn:ietf:params:oauth:grant-type:jwt-bearer" Grant)
    PASSWORD
    Resource Owner Password "password" Grant (specification conforming grant).
    REFRESH_TOKEN
    Use Refresh Tokens (specification conforming grant).
    SAML2_BEARER
    Use SAML 2.0 Bearer "urn:ietf:params:oauth:grant-type:saml2-bearer" Grant (flow for SAML 2.0 Bearer Grant).
    TOKEN_EXCHANGE
    Use Token Exchange (flow for OAuth 2.0 Token Exchange "urn:ietf:params:oauth:grant-type:token-exchange" Grant).
    UMA_TICKET
    Use UMA "urn:ietf:params:oauth:grant-type:uma-ticket" Grant (flow for UMA Grant).

  • Method Summary

    Modifier and Type
    Method
    Description
    static GrantType
    fromName(String aName)
    Returns that GrantType represented by the given name.
    String
    getValue()
    Returns the value representing the given GrantType.
    static GrantType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static GrantType[]
    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

    Methods inherited from interface org.refcodes.mixin.ValueAccessor

    getValueOr

  • Enum Constant Details

    • IMPLICIT

      public static final GrantType IMPLICIT
      Implicit "implicit" Grant (specification conforming grant).

    • AUTHORIZATION_CODE

      public static final GrantType AUTHORIZATION_CODE
      Authorization Code "authorization_code" Grant (specification conforming grant).

    • CLIENT_CREDENTIALS

      public static final GrantType CLIENT_CREDENTIALS
      Client Credentials "client_credentials" Grant (specification conforming grant).

    • PASSWORD

      public static final GrantType PASSWORD
      Resource Owner Password "password" Grant (specification conforming grant).

    • REFRESH_TOKEN

      public static final GrantType REFRESH_TOKEN
      Use Refresh Tokens (specification conforming grant).

    • DEVICE_CODE

      public static final GrantType DEVICE_CODE
      Device Authorization "urn:ietf:params:oauth:grant-type:device_code" Grant (specification conforming grant).

    • JWT_BEARER

      public static final GrantType JWT_BEARER
      Use JWT Bearer (JWT Bearer "urn:ietf:params:oauth:grant-type:jwt-bearer" Grant)

    • UMA_TICKET

      public static final GrantType UMA_TICKET
      Use UMA "urn:ietf:params:oauth:grant-type:uma-ticket" Grant (flow for UMA Grant).

    • SAML2_BEARER

      public static final GrantType SAML2_BEARER
      Use SAML 2.0 Bearer "urn:ietf:params:oauth:grant-type:saml2-bearer" Grant (flow for SAML 2.0 Bearer Grant).

    • TOKEN_EXCHANGE

      public static final GrantType TOKEN_EXCHANGE
      Use Token Exchange (flow for OAuth 2.0 Token Exchange "urn:ietf:params:oauth:grant-type:token-exchange" Grant).

    • AUTH0_PASSWORD_REALM

      public static final GrantType AUTH0_PASSWORD_REALM
      Use an extension grant "http://auth0.com/oauth/grant-type/password-realm" similar to the Resource Owner Password Grant that includes the ability to indicate a specific realm (Auth0 extension grant).

    • AUTH0_MFA_OOB

      public static final GrantType AUTH0_MFA_OOB
      Multi-factor Authentication OOB "http://auth0.com/oauth/grant-type/mfa-oob" Grant Request (Auth0 extension grant).

    • AUTH0_MFA_OTP

      public static final GrantType AUTH0_MFA_OTP
      Multi-factor Authentication OTP "http://auth0.com/oauth/grant-type/mfa-otp" Grant Request (Auth0 extension grant).

    • AUTH0_MFA_RECOVERY_CODE

      public static final GrantType AUTH0_MFA_RECOVERY_CODE
      Multi-factor Authentication Recovery "http://auth0.com/oauth/grant-type/mfa-recovery-code" Grant Request (Auth0 extension grant).

    • AUTH0_PASSWORDLESS_OTP

      public static final GrantType AUTH0_PASSWORDLESS_OTP
      Embedded Passwordless Login "http://auth0.com/oauth/grant-type/passwordless/otp" Grant Request (Auth0 extension grant).

    • AUTH0_LEGACY_RO

      public static final GrantType AUTH0_LEGACY_RO
      Use legacy RO "http://auth0.com/oauth/legacy/grant-type/ro" Grant (Auth0 legacy grant).

    • AUTH0_LEGACY_RO_JWT_BEARER

      public static final GrantType AUTH0_LEGACY_RO_JWT_BEARER
      Use legacy JWT-Bearer "http://auth0.com/oauth/legacy/grant-type/ro/jwt-bearer" Grant (Auth0 legacy grant).

    • AUTH0_LEGACY_DELEGATION_REFRESH_TOKEN

      public static final GrantType AUTH0_LEGACY_DELEGATION_REFRESH_TOKEN
      Use Legacy Refresh Tokens "http://auth0.com/oauth/legacy/grant-type/delegation/refresh_token" Grant (Auth0 legacy grant).

    • AUTH0_LEGACY_DELEGATION_ID_TOKEN

      public static final GrantType AUTH0_LEGACY_DELEGATION_ID_TOKEN
      Use legacy ID Token "http://auth0.com/oauth/legacy/grant-type/delegation/id_token" Grant (Auth0 legacy grant).

    • AUTH0_LEGACY_ACCESS_TOKEN

      public static final GrantType AUTH0_LEGACY_ACCESS_TOKEN
      Use legacy Access Token "http://auth0.com/oauth/legacy/grant-type/access_token" Grant (Auth0 legacy grant).

  • Method Details

    • values

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

    • getValue

      public String getValue()
      Returns the value representing the given GrantType.
      Specified by:
      getValue in interface org.refcodes.mixin.ValueAccessor<String>
      Returns:
      the according value.

    • fromName

      public static GrantType fromName(String aName)
      Returns that GrantType represented by the given name.
      Parameters:
      aName - The name for which to determine the GrantType.
      Returns:
      The determined GrantType or null if none was determinable.