Safe Haskell	None
Language	Haskell2010

Keycloak.Types

Contents

Keycloak Monad
Token
Permissions
User
Owner
Resource

Synopsis

type Keycloak a = ReaderT KCConfig (ExceptT KCError IO) a
data KCError
- = HTTPError HttpException
- | ParseError Text
- | EmptyError
data KCConfig = KCConfig {
- _baseUrl :: Text
- _realm :: Text
- _clientId :: Text
- _clientSecret :: Text
}
defaultKCConfig :: KCConfig
runKeycloak :: Keycloak a -> KCConfig -> IO (Either KCError a)
type Path = Text
newtype Token = Token {
- unToken :: ByteString
}
extractBearerAuth :: ByteString -> Maybe ByteString
tokNonce :: Text
tokAuthTime :: Text
tokSessionState :: Text
tokAtHash :: Text
tokCHash :: Text
tokName :: Text
tokGivenName :: Text
tokFamilyName :: Text
tokMiddleName :: Text
tokNickName :: Text
tokPreferredUsername :: Text
tokProfile :: Text
tokPicture :: Text
tokWebsite :: Text
tokEmail :: Text
tokEmailVerified :: Text
tokGender :: Text
tokBirthdate :: Text
tokZoneinfo :: Text
tokLocale :: Text
tokPhoneNumber :: Text
tokPhoneNumberVerified :: Text
tokAddress :: Text
tokUpdateAt :: Text
tokClaimsLocales :: Text
tokACR :: Text
data TokenRep = TokenRep {
- accessToken :: Text
- expiresIn :: Int
- refreshExpriresIn :: Int
- refreshToken :: Text
- tokenType :: Text
- notBeforePolicy :: Int
- sessionState :: Text
- tokenScope :: Text
}
newtype ScopeName = ScopeName {
- unScopeName :: Text
}
newtype ScopeId = ScopeId {
- unScopeId :: Text
}
data Scope = Scope {
- scopeId :: Maybe ScopeId
- scopeName :: ScopeName
}
data Permission = Permission {
- permRsid :: Maybe ResourceId
- permRsname :: Maybe ResourceName
- permScopes :: [ScopeName]
}
data PermReq = PermReq {
- permReqResourceId :: Maybe ResourceId
- permReqScopes :: [ScopeName]
}
type Username = Text
type Password = Text
type First = Int
type Max = Int
newtype UserId = UserId {
- unUserId :: Text
}
data User = User {
- userId :: Maybe UserId
- userUsername :: Username
- userFirstName :: Maybe Text
- userLastName :: Maybe Text
- userEmail :: Maybe Text
- userAttributes :: Maybe (Map Text [Text])
}
unCapitalize :: String -> String
data Owner = Owner {
- ownId :: Maybe Text
- ownName :: Maybe Username
}
type ResourceName = Text
type ResourceType = Text
newtype ResourceId = ResourceId {
- unResId :: Text
}
data Resource = Resource {
- resId :: Maybe ResourceId
- resName :: ResourceName
- resType :: Maybe ResourceType
- resUris :: [Text]
- resScopes :: [Scope]
- resOwner :: Owner
- resOwnerManagedAccess :: Bool
- resAttributes :: [Attribute]
}
data Attribute = Attribute {
- attName :: Text
- attValues :: [Text]
}
realm :: Lens' KCConfig Text
clientSecret :: Lens' KCConfig Text
clientId :: Lens' KCConfig Text
baseUrl :: Lens' KCConfig Text

Keycloak Monad

type Keycloak a = ReaderT KCConfig (ExceptT KCError IO) a Source #

Keycloak Monad stack: a simple Reader monad containing the config, and an ExceptT to handle HTTPErrors and parse errors.

data KCError Source #

Contains HTTP errors and parse errors.

Constructors

HTTPError HttpException	Keycloak returned an HTTP error.
ParseError Text	Failed when parsing the response
EmptyError	Empty error to serve as a zero element for Monoid.

Instances

Show KCError Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> KCError -> ShowS # show :: KCError -> String # showList :: [KCError] -> ShowS #

data KCConfig Source #

Configuration of Keycloak.

Constructors

KCConfig
Fields _baseUrl :: Text _realm :: Text _clientId :: Text _clientSecret :: Text

Instances

Eq KCConfig Source #
Instance details Defined in Keycloak.Types Methods (==) :: KCConfig -> KCConfig -> Bool # (/=) :: KCConfig -> KCConfig -> Bool #
Show KCConfig Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> KCConfig -> ShowS # show :: KCConfig -> String # showList :: [KCConfig] -> ShowS #

defaultKCConfig :: KCConfig Source #

Default configuration

runKeycloak :: Keycloak a -> KCConfig -> IO (Either KCError a) Source #

Run a Keycloak monad within IO.

type Path = Text Source #

Token

newtype Token Source #

Wrapper for tokens.

Constructors

Token
Fields unToken :: ByteString

Instances

Eq Token Source #
Instance details Defined in Keycloak.Types Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #
Show Token Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #
Generic Token Source #
Instance details Defined in Keycloak.Types Associated Types type Rep Token :: Type -> Type # Methods from :: Token -> Rep Token x # to :: Rep Token x -> Token #
ToJSON Token Source #
Instance details Defined in Keycloak.Types Methods toJSON :: Token -> Value # toEncoding :: Token -> Encoding # toJSONList :: [Token] -> Value # toEncodingList :: [Token] -> Encoding #
ToHttpApiData Token Source #	Create Authorization header
Instance details Defined in Keycloak.Types Methods toUrlPiece :: Token -> Text # toEncodedUrlPiece :: Token -> Builder # toHeader :: Token -> ByteString # toQueryParam :: Token -> Text #
FromHttpApiData Token Source #	parser for Authorization header
Instance details Defined in Keycloak.Types Methods parseUrlPiece :: Text -> Either Text Token # parseHeader :: ByteString -> Either Text Token # parseQueryParam :: Text -> Either Text Token #
type Rep Token Source #
Instance details Defined in Keycloak.Types type Rep Token = D1 (MetaData "Token" "Keycloak.Types" "keycloak-hs-1.0.1-Dv1gYbAOFZ7EsyySRU9vHf" True) (C1 (MetaCons "Token" PrefixI True) (S1 (MetaSel (Just "unToken") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))

extractBearerAuth :: ByteString -> Maybe ByteString Source #

tokNonce :: Text Source #