| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Security.AccessTokenProvider
- new :: (MonadUnliftIO m, MonadMask m) => AccessTokenName -> m (AccessTokenProvider m t)
- newWithProviders :: MonadThrow m => Backend m -> NonEmpty (AtpProbe m) -> AccessTokenName -> m (AccessTokenProvider m t)
- newWithBackend :: (MonadUnliftIO m, MonadMask m) => Backend m -> AccessTokenName -> m (AccessTokenProvider m t)
- probeProviderFile :: (MonadUnliftIO m, MonadCatch m) => AtpProbe m
- probeProviderFixed :: (MonadIO m, MonadCatch m) => AtpProbe m
- probeProviderSimpleFixed :: (MonadIO m, MonadCatch m) => AtpProbe m
- probeProviderRopcg :: (MonadMask m, MonadUnliftIO m) => AtpProbe m
- defaultProviders :: (MonadUnliftIO m, MonadMask m) => NonEmpty (AtpProbe m)
- newtype AccessTokenName = AccessTokenName Text
- data AccessTokenProvider (m :: * -> *) t = AccessTokenProvider {
- retrieveAccessToken :: m (AccessToken t)
- releaseProvider :: m ()
- newtype AccessToken t = AccessToken {}
- newtype AtpProbe m = AtpProbe (forall t. Backend m -> AccessTokenName -> m (Maybe (AccessTokenProvider m t)))
Documentation
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.
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.
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 Source #
Access Token Provider prober for file based access token retrieval.
probeProviderFixed :: (MonadIO m, MonadCatch m) => AtpProbe m Source #
Access Token Provider prober for environment based access token retrieval.
probeProviderSimpleFixed :: (MonadIO m, MonadCatch m) => AtpProbe m Source #
Access Token Provider prober for access token retrieval from the
TOKEN environment retrieval.
probeProviderRopcg :: (MonadMask m, MonadUnliftIO m) => AtpProbe m Source #
Access Token Provider prober for access token retrieval via OAuth2 Resource-Owner-Password-Credentails-Grant.
defaultProviders :: (MonadUnliftIO m, MonadMask m) => NonEmpty (AtpProbe m) Source #
List of default providers: Fixed (environment) provider, file-based provider, OAuth2 Resource-Owner-Password-Credentials-Grant provider.
newtype AccessTokenName Source #
Constructors
| AccessTokenName Text |
data AccessTokenProvider (m :: * -> *) t Source #
Constructors
| AccessTokenProvider | |
Fields
| |
newtype AccessToken t Source #
Constructors
| AccessToken | |
Fields | |
Instances
| Eq (AccessToken t) Source # | |
| Ord (AccessToken t) Source # | |
| Show (AccessToken t) Source # | |
Constructors
| AtpProbe (forall t. Backend m -> AccessTokenName -> m (Maybe (AccessTokenProvider m t))) |