Network.PlanB.Introspection

Documentation

data TokenInfo

Information returned on a successful token introspection.

Constructors

TokenInfo

Fields

• tokenInfoExpiresIn :: Int
• tokenInfoScope :: Set Text
• tokenInfoUid :: Text
• tokenInfoRealm :: Text

Instances

Show TokenInfo

Defined in Network.PlanB.Introspection.Internal.Types

Methods

showsPrec :: Int -> TokenInfo -> ShowS

show :: TokenInfo -> String

showList :: [TokenInfo] -> ShowS

Generic TokenInfo

Defined in Network.PlanB.Introspection.Internal.Types

Associated Types

type Rep TokenInfo :: Type -> Type

Methods

from :: TokenInfo -> Rep TokenInfo x

to :: Rep TokenInfo x -> TokenInfo

ToJSON TokenInfo

Defined in Network.PlanB.Introspection.Internal.Types

Methods

toJSON :: TokenInfo -> Value

toEncoding :: TokenInfo -> Encoding

toJSONList :: [TokenInfo] -> Value

toEncodingList :: [TokenInfo] -> Encoding

FromJSON TokenInfo

Defined in Network.PlanB.Introspection.Internal.Types

Methods

parseJSON :: Value -> Parser TokenInfo

parseJSONList :: Value -> Parser [TokenInfo]

type Rep TokenInfo

Defined in Network.PlanB.Introspection.Internal.Types

type Rep TokenInfo = D1 (MetaData "TokenInfo" "Network.PlanB.Introspection.Internal.Types" "planb-token-introspection-0.1.4.0-BcrjmGCfBxW3UAbM4QCMBf" False) (C1 (MetaCons "TokenInfo" PrefixI True) ((S1 (MetaSel (Just "tokenInfoExpiresIn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Just "tokenInfoScope") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Text))) :*: (S1 (MetaSel (Just "tokenInfoUid") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "tokenInfoRealm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))

data IntrospectionError

This type models the error scenarios specific to a token introspection attempt. These can be used as exceptions and are in fact thrown by a PlanB token introspector.

Constructors

DeserializationFailure Text ByteString

InvalidRequest ErrorResponse

InvalidToken ErrorResponse

Other ErrorResponse

NoEndpoint

Instances

Eq IntrospectionError

Defined in Network.PlanB.Introspection.Internal.Types

Methods

(==) :: IntrospectionError -> IntrospectionError -> Bool

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

Show IntrospectionError

Defined in Network.PlanB.Introspection.Internal.Types

Methods

showsPrec :: Int -> IntrospectionError -> ShowS

show :: IntrospectionError -> String

showList :: [IntrospectionError] -> ShowS

Generic IntrospectionError

Defined in Network.PlanB.Introspection.Internal.Types

Associated Types

type Rep IntrospectionError :: Type -> Type

Methods

from :: IntrospectionError -> Rep IntrospectionError x

to :: Rep IntrospectionError x -> IntrospectionError

Exception IntrospectionError

Defined in Network.PlanB.Introspection.Internal.Types

Methods

toException :: IntrospectionError -> SomeException

fromException :: SomeException -> Maybe IntrospectionError

displayException :: IntrospectionError -> String

type Rep IntrospectionError

Defined in Network.PlanB.Introspection.Internal.Types

type Rep IntrospectionError = D1 (MetaData "IntrospectionError" "Network.PlanB.Introspection.Internal.Types" "planb-token-introspection-0.1.4.0-BcrjmGCfBxW3UAbM4QCMBf" False) ((C1 (MetaCons "DeserializationFailure" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)) :+: C1 (MetaCons "InvalidRequest" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ErrorResponse))) :+: (C1 (MetaCons "InvalidToken" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ErrorResponse)) :+: (C1 (MetaCons "Other" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ErrorResponse)) :+: C1 (MetaCons "NoEndpoint" PrefixI False) (U1 :: Type -> Type))))

data ErrorResponse

Contains the error response data returned from a PlanB server in case of an introspection error.

Constructors

ErrorResponse

Fields

• errorResponseError :: Text
• errorResponseErrorDescription :: Maybe Text

Instances

Eq ErrorResponse

Defined in Network.PlanB.Introspection.Internal.Types

Methods

(==) :: ErrorResponse -> ErrorResponse -> Bool

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

Show ErrorResponse

Defined in Network.PlanB.Introspection.Internal.Types

Methods

showsPrec :: Int -> ErrorResponse -> ShowS

show :: ErrorResponse -> String

showList :: [ErrorResponse] -> ShowS

Generic ErrorResponse

Defined in Network.PlanB.Introspection.Internal.Types

Associated Types

type Rep ErrorResponse :: Type -> Type

Methods

from :: ErrorResponse -> Rep ErrorResponse x

to :: Rep ErrorResponse x -> ErrorResponse

ToJSON ErrorResponse

Defined in Network.PlanB.Introspection.Internal.Types

Methods

toJSON :: ErrorResponse -> Value

toEncoding :: ErrorResponse -> Encoding

toJSONList :: [ErrorResponse] -> Value

toEncodingList :: [ErrorResponse] -> Encoding

FromJSON ErrorResponse

Defined in Network.PlanB.Introspection.Internal.Types

Methods

parseJSON :: Value -> Parser ErrorResponse

parseJSONList :: Value -> Parser [ErrorResponse]

type Rep ErrorResponse

Defined in Network.PlanB.Introspection.Internal.Types

type Rep ErrorResponse = D1 (MetaData "ErrorResponse" "Network.PlanB.Introspection.Internal.Types" "planb-token-introspection-0.1.4.0-BcrjmGCfBxW3UAbM4QCMBf" False) (C1 (MetaCons "ErrorResponse" PrefixI True) (S1 (MetaSel (Just "errorResponseError") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "errorResponseErrorDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))

data TokenIntrospector m

A TokenIntrospector can be used for introspecting tokens.

Constructors

TokenIntrospector

Fields

• introspectToken :: ByteString -> m TokenInfo

  Introspect the provided token.

new :: (MonadThrow m, MonadIO m) => Text -> m (TokenIntrospector m)

Create a new PlanB token introspector using the provided endpoint. Uses a global default HTTP manager.

newWithManager :: (MonadThrow m, MonadIO m) => Manager -> Text -> m (TokenIntrospector m)

Create a new PlanB toke introspector using the provided endpoint and HTTP manager.

newFromEnv :: (MonadThrow m, MonadIO m) => Maybe Manager -> m (TokenIntrospector m)

Convenience function. Create a new PlanB introspector using the provided manager. The PlanB server to use is retrieved from the environment variable PLANB_INTROSPECTION_ENDPOINT.