Package io.quarkus.oidc

Interface OidcSession

All Known Implementing Classes:
OidcSessionImpl
public interface OidcSession

  • Method Summary

    Modifier and Type
    Method
    Description
    Instant
    expiresAt()
    Return an Instant representing the current session's expiration time.
    Instant
    expiresIn()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method shouldn't be used as it provides an instant corresponding to 1970-01-01T0:0:0Z plus the duration of the validity of the token, which is impractical.
    org.eclipse.microprofile.jwt.JsonWebToken
    getIdToken()
    Return the ID token the current session depends upon.
    String
    getTenantId()
    Return the tenant identifier of the current session
    io.smallrye.mutiny.Uni<Void>
    logout()
    Perform a local logout without a redirect to the OpenId Connect provider.
    Duration
    validFor()
    Return a Duration indicating how long the current session will remain valid for starting from this method's invocation time.

  • Method Details

    • getTenantId

      String getTenantId()
      Return the tenant identifier of the current session
      Returns:
      tenant id

    • expiresIn

      @Deprecated(forRemoval=true, since="2.12.0") Instant expiresIn()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method shouldn't be used as it provides an instant corresponding to 1970-01-01T0:0:0Z plus the duration of the validity of the token, which is impractical. Please use either expiresAt() or validFor() depending on your requirements. This method will be removed in a later version of Quarkus.
      Return an indicating how long will it take for the current session to expire.
      Returns:
      Instant

    • expiresAt

      Instant expiresAt()
      Return an Instant representing the current session's expiration time.
      Returns:
      Instant

    • validFor

      Duration validFor()
      Return a Duration indicating how long the current session will remain valid for starting from this method's invocation time.
      Returns:
      Duration

    • logout

      io.smallrye.mutiny.Uni<Void> logout()
      Perform a local logout without a redirect to the OpenId Connect provider.
      Returns:
      Uni

    • getIdToken

      org.eclipse.microprofile.jwt.JsonWebToken getIdToken()
      Return the ID token the current session depends upon.
      Returns:
      id token