Safe Haskell	Safe-Inferred
Language	Haskell2010

Polysemy.Account.Api.Effect.Authorize

Description

Synopsis

data Authorize i param priv :: Effect where
- Authorize :: param -> AuthedAccount i priv -> Authorize i param priv m (Maybe Text)
authorize :: forall i param priv r. Member (Authorize i param priv) r => param -> AuthedAccount i priv -> Sem r (Maybe Text)
type AuthorizeP i = Authorize i [Privilege] [Privilege]

Documentation

data Authorize i param priv :: Effect where Source #

This effect is used by the combinators in Polysemy.Account.Api.Server.AuthEndpoint to decide whether an account is authorized to access an endpoint.

The type parameters signify:

Constructors

Authorize :: param -> AuthedAccount i priv -> Authorize i param priv m (Maybe Text)

Decide whether the given account is authorized to use the endpoint characterized by the param. Return Just an error message if access is denied.

authorize :: forall i param priv r. Member (Authorize i param priv) r => param -> AuthedAccount i priv -> Sem r (Maybe Text) Source #

Decide whether the given account is authorized to use the endpoint characterized by the param. Return Just an error message if access is denied.

Convenience alias for using the default privilege type with Authorize.