BearerTokenAuthenticator

tsec.authentication.BearerTokenAuthenticator
See theBearerTokenAuthenticator companion object
sealed abstract class BearerTokenAuthenticator[F[_], I, V] extends Authenticator[F, I, V, TSecBearerToken[I]]

Attributes

Companion
object
Source
BearerTokenAuthenticator.scala
Graph
Supertypes
class Authenticator[F, I, V, TSecBearerToken[I]]
class Object
trait Matchable
class Any

Members list

Value members

Inherited methods

def afterBlock(response: Response[F], authenticator: TSecBearerToken[I]): OptionT[F, Response[F]]

Handles the embedding of the authenticator (if necessary) in the response, and any other actions that should happen after a request related to authenticators

Handles the embedding of the authenticator (if necessary) in the response, and any other actions that should happen after a request related to authenticators

Attributes

Returns
Inherited from:
Authenticator
Source
Authenticator.scala
def create(body: I): F[A]

Create an authenticator from an identifier.

Create an authenticator from an identifier.

Attributes

Returns
Inherited from:
Authenticator
Source
Authenticator.scala
def discard(authenticator: TSecBearerToken[I]): F[A]

Delete an authenticator from a backing store, or invalidate it.

Delete an authenticator from a backing store, or invalidate it.

Attributes

Returns
Inherited from:
Authenticator
Source
Authenticator.scala
def embed(response: Response[F], authenticator: TSecBearerToken[I]): Response[F]

Embed an authenticator directly into a response.

Embed an authenticator directly into a response. Particularly useful for adding an authenticator into unauthenticated actions

Attributes

Returns
Inherited from:
Authenticator
Source
Authenticator.scala
def extractAndValidate(request: Request[F]): OptionT[F, SecuredRequest[F, V, A]]

Return a secured request from a request, that carries our authenticator

Return a secured request from a request, that carries our authenticator

Attributes

Returns
Inherited from:
Authenticator
Source
Authenticator.scala
def extractRawOption(request: Request[F]): Option[String]

Attempt to retrieve the raw representation of an A This is primarily useful when attempting to combine AuthenticatorService, to be able to evaluate an endpoint with more than one token type.

Attempt to retrieve the raw representation of an A This is primarily useful when attempting to combine AuthenticatorService, to be able to evaluate an endpoint with more than one token type. or simply just to prod whether the request is malformed.

Attributes

Returns
Inherited from:
Authenticator
Source
Authenticator.scala
def parseRaw(raw: String, request: Request[F]): OptionT[F, SecuredRequest[F, V, A]]

Parse the raw representation from extractRawOption

Parse the raw representation from extractRawOption

Attributes

Inherited from:
Authenticator
Source
Authenticator.scala
def refresh(authenticator: TSecBearerToken[I]): F[A]

Refresh an authenticator: Primarily used for sliding window expiration

Refresh an authenticator: Primarily used for sliding window expiration

Attributes

Returns
Inherited from:
Authenticator
Source
Authenticator.scala
def renew(authenticator: TSecBearerToken[I]): F[A]

Renew an authenticator: Reset it's expiry and whatnot.

Renew an authenticator: Reset it's expiry and whatnot.

Attributes

Returns
Inherited from:
Authenticator
Source
Authenticator.scala
def update(authenticator: TSecBearerToken[I]): F[A]

Update the altered authenticator

Update the altered authenticator

Attributes

Returns
Inherited from:
Authenticator
Source
Authenticator.scala