Package io.quarkus.oidc.client

Enum Class OidcClientConfig.Grant.Type

java.lang.Object
java.lang.Enum<OidcClientConfig.Grant.Type>
io.quarkus.oidc.client.OidcClientConfig.Grant.Type
All Implemented Interfaces:
Serializable, Comparable<OidcClientConfig.Grant.Type>, Constable
Enclosing class:
OidcClientConfig.Grant
public static enum OidcClientConfig.Grant.Type extends Enum<OidcClientConfig.Grant.Type>

  • Nested Class Summary

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

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CIBA
    'urn:openid:params:grant-type:ciba' grant requiring an OIDC client authentication as well as 'auth_req_id' parameter which must be passed to OidcClient at the token request time.
    CLIENT
    'client_credentials' grant requiring an OIDC client authentication only
    CODE
    'authorization_code' grant requiring an OIDC client authentication as well as at least 'code' and 'redirect_uri' parameters which must be passed to OidcClient at the token request time.
    EXCHANGE
    'urn:ietf:params:oauth:grant-type:token-exchange' grant requiring an OIDC client authentication as well as at least 'subject_token' parameter which must be passed to OidcClient at the token request time.
    JWT
    'urn:ietf:params:oauth:grant-type:jwt-bearer' grant requiring an OIDC client authentication as well as at least an 'assertion' parameter which must be passed to OidcClient at the token request time.
    PASSWORD
    'password' grant requiring both OIDC client and user ('username' and 'password') authentications
    REFRESH
    'refresh_token' grant requiring an OIDC client authentication and a refresh token.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getGrantType()
     
    static OidcClientConfig.Grant.Type
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static OidcClientConfig.Grant.Type[]
    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

  • Enum Constant Details

    • CLIENT

      public static final OidcClientConfig.Grant.Type CLIENT
      'client_credentials' grant requiring an OIDC client authentication only

    • PASSWORD

      public static final OidcClientConfig.Grant.Type PASSWORD
      'password' grant requiring both OIDC client and user ('username' and 'password') authentications

    • CODE

      public static final OidcClientConfig.Grant.Type CODE
      'authorization_code' grant requiring an OIDC client authentication as well as at least 'code' and 'redirect_uri' parameters which must be passed to OidcClient at the token request time.

    • EXCHANGE

      public static final OidcClientConfig.Grant.Type EXCHANGE
      'urn:ietf:params:oauth:grant-type:token-exchange' grant requiring an OIDC client authentication as well as at least 'subject_token' parameter which must be passed to OidcClient at the token request time.

    • JWT

      public static final OidcClientConfig.Grant.Type JWT
      'urn:ietf:params:oauth:grant-type:jwt-bearer' grant requiring an OIDC client authentication as well as at least an 'assertion' parameter which must be passed to OidcClient at the token request time.

    • REFRESH

      public static final OidcClientConfig.Grant.Type REFRESH
      'refresh_token' grant requiring an OIDC client authentication and a refresh token. Note, OidcClient supports this grant by default if an access token acquisition response contained a refresh token. However, in some cases, the refresh token is provided out of band, for example, it can be shared between several of the confidential client's services, etc. If 'quarkus.oidc-client.grant-type' is set to 'refresh' then `OidcClient` will only support refreshing the tokens.

    • CIBA

      public static final OidcClientConfig.Grant.Type CIBA
      'urn:openid:params:grant-type:ciba' grant requiring an OIDC client authentication as well as 'auth_req_id' parameter which must be passed to OidcClient at the token request time.

  • Method Details

    • values

      public static OidcClientConfig.Grant.Type[] 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 OidcClientConfig.Grant.Type 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

    • getGrantType

      public String getGrantType()