Security.AccessTokenProvider

Documentation

new

Arguments

:: (MonadUnliftIO m, MonadMask m)

=> AccessTokenName

Name of the access token to create a provider for.

-> m (AccessTokenProvider m t)

Create a new access token provider using the default IO-based backend and the default providers.

newWithProviders

Arguments

:: MonadThrow m

=> Backend m

Backend to use.

-> NonEmpty (AtpProbe m)

List of providers to use.

-> AccessTokenName

Name of the access token to create a provider for.

-> m (AccessTokenProvider m t)

Create a new access token provider, specifying backend and list of providers.

newWithBackend

Arguments

:: (MonadUnliftIO m, MonadMask m)

=> Backend m

Backend to ue.

-> AccessTokenName

Name of the access token to create a provider for.

-> m (AccessTokenProvider m t)

Create a new access token provider, specifying the backend to use, using the default providers.

probeProviderFile :: (MonadUnliftIO m, MonadCatch m) => AtpProbe m

Access Token Provider prober for file based access token retrieval.

probeProviderFixed :: (MonadIO m, MonadCatch m) => AtpProbe m

Access Token Provider prober for environment based access token retrieval.

probeProviderSimpleFixed :: (MonadIO m, MonadCatch m) => AtpProbe m

Access Token Provider prober for access token retrieval from the TOKEN environment retrieval.

probeProviderRopcg :: (MonadMask m, MonadUnliftIO m) => AtpProbe m

Access Token Provider prober for access token retrieval via OAuth2 Resource-Owner-Password-Credentails-Grant.

defaultProviders :: (MonadUnliftIO m, MonadMask m) => NonEmpty (AtpProbe m)

List of default providers: Fixed (environment) provider, file-based provider, OAuth2 Resource-Owner-Password-Credentials-Grant provider.

newtype AccessTokenName

Constructors

AccessTokenName Text

Instances

Eq AccessTokenName

Methods

(==) :: AccessTokenName -> AccessTokenName -> Bool

(/=) :: AccessTokenName -> AccessTokenName -> Bool

Ord AccessTokenName

Methods

compare :: AccessTokenName -> AccessTokenName -> Ordering

(<) :: AccessTokenName -> AccessTokenName -> Bool

(<=) :: AccessTokenName -> AccessTokenName -> Bool

(>) :: AccessTokenName -> AccessTokenName -> Bool

(>=) :: AccessTokenName -> AccessTokenName -> Bool

max :: AccessTokenName -> AccessTokenName -> AccessTokenName

min :: AccessTokenName -> AccessTokenName -> AccessTokenName

Show AccessTokenName

Methods

showsPrec :: Int -> AccessTokenName -> ShowS

show :: AccessTokenName -> String

showList :: [AccessTokenName] -> ShowS

IsString AccessTokenName

Methods

fromString :: String -> AccessTokenName

ToJSON AccessTokenName

Methods

toJSON :: AccessTokenName -> Value

toEncoding :: AccessTokenName -> Encoding

toJSONList :: [AccessTokenName] -> Value

toEncodingList :: [AccessTokenName] -> Encoding

FromJSON AccessTokenName

Methods

parseJSON :: Value -> Parser AccessTokenName

parseJSONList :: Value -> Parser [AccessTokenName]

Format AccessTokenName

Methods

formatText :: AccessTokenName -> Text

data AccessTokenProvider (m :: * -> *) t

Constructors

AccessTokenProvider

Fields

• retrieveAccessToken :: m (AccessToken t)
• releaseProvider :: m ()

newtype AccessToken t

Constructors

AccessToken

Fields

• unAccessToken :: Text

Instances

Eq (AccessToken t)

Methods

(==) :: AccessToken t -> AccessToken t -> Bool

(/=) :: AccessToken t -> AccessToken t -> Bool

Ord (AccessToken t)

Methods

compare :: AccessToken t -> AccessToken t -> Ordering

(<) :: AccessToken t -> AccessToken t -> Bool

(<=) :: AccessToken t -> AccessToken t -> Bool

(>) :: AccessToken t -> AccessToken t -> Bool

(>=) :: AccessToken t -> AccessToken t -> Bool

max :: AccessToken t -> AccessToken t -> AccessToken t

min :: AccessToken t -> AccessToken t -> AccessToken t

Show (AccessToken t)

Methods

showsPrec :: Int -> AccessToken t -> ShowS

show :: AccessToken t -> String

showList :: [AccessToken t] -> ShowS

newtype AtpProbe m

Constructors

AtpProbe (forall t. Backend m -> AccessTokenName -> m (Maybe (AccessTokenProvider m t)))