Safe Haskell	Safe-Inferred
Language	Haskell2010

Keycloak.Types

Contents

Keycloak Monad
Token
Permissions
User
Owner
Resource

Synopsis

type JWT = SignedJWT
type Keycloak a = KeycloakT IO a
newtype KeycloakT m a = KeycloakT {
- unKeycloakT :: ReaderT KCConfig (ExceptT KCError m) a
}
data KCError
- = HTTPError HttpException
- | ParseError Text
- | JWTError JWTError
- | EmptyError
data KCConfig = KCConfig {
- _confAdapterConfig :: AdapterConfig
- _confJWKs :: [JWK]
}
type Realm = Text
type ClientId = Text
type ServerURL = Text
data AdapterConfig = AdapterConfig {
- _confRealm :: Realm
- _confAuthServerUrl :: ServerURL
- _confResource :: ClientId
- _confCredentials :: ClientCredentials
}
data ClientCredentials = ClientCredentials {
- _confSecret :: Text
}
trainDrop :: Int -> Options
defaultAdapterConfig :: AdapterConfig
runKeycloak :: Monad m => KeycloakT m a -> KCConfig -> m (Either KCError a)
type Path = 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 PermReq = PermReq {
- permReqResourceId :: Maybe ResourceId
- permReqScopes :: [ScopeName]
}
data Permission = Permission {
- permRsid :: Maybe ResourceId
- permRsname :: Maybe ResourceName
- permScopes :: [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 Value)
}
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]
}
confJWKs :: Lens' KCConfig [JWK]
confAdapterConfig :: Lens' KCConfig AdapterConfig
confSecret :: Iso' ClientCredentials Text
confResource :: Lens' AdapterConfig ClientId
confRealm :: Lens' AdapterConfig Realm
confCredentials :: Lens' AdapterConfig ClientCredentials
confAuthServerUrl :: Lens' AdapterConfig ServerURL

Documentation

type JWT = SignedJWT Source #

Our Json Web Token as returned by Keycloak

Keycloak Monad

type Keycloak a = KeycloakT IO a Source #

Keycloak Monad stack: a simple Reader monad containing the config, and an ExceptT to handle HTTPErrors and parse errors. You can extract the value using runKeycloak. Example: keys <- runKeycloak getJWKs defaultKCConfig

newtype KeycloakT m a Source #

Constructors

KeycloakT
Fields unKeycloakT :: ReaderT KCConfig (ExceptT KCError m) a

Instances

Instances details

MonadTrans KeycloakT Source #
Instance details Defined in Keycloak.Types Methods lift :: Monad m => m a -> KeycloakT m a #
MonadIO m => MonadIO (KeycloakT m) Source #
Instance details Defined in Keycloak.Types Methods liftIO :: IO a -> KeycloakT m a #
Monad m => Applicative (KeycloakT m) Source #
Instance details Defined in Keycloak.Types Methods pure :: a -> KeycloakT m a # (<>) :: KeycloakT m (a -> b) -> KeycloakT m a -> KeycloakT m b # liftA2 :: (a -> b -> c) -> KeycloakT m a -> KeycloakT m b -> KeycloakT m c # (>) :: KeycloakT m a -> KeycloakT m b -> KeycloakT m b # (<*) :: KeycloakT m a -> KeycloakT m b -> KeycloakT m a #
Functor m => Functor (KeycloakT m) Source #
Instance details Defined in Keycloak.Types Methods fmap :: (a -> b) -> KeycloakT m a -> KeycloakT m b # (<$) :: a -> KeycloakT m b -> KeycloakT m a #
Monad m => Monad (KeycloakT m) Source #
Instance details Defined in Keycloak.Types Methods (>>=) :: KeycloakT m a -> (a -> KeycloakT m b) -> KeycloakT m b # (>>) :: KeycloakT m a -> KeycloakT m b -> KeycloakT m b # return :: a -> KeycloakT m a #
MonadTime m => MonadTime (KeycloakT m) Source #
Instance details Defined in Keycloak.Types Methods currentTime :: KeycloakT m UTCTime # monotonicTime :: KeycloakT m Double #

data KCError Source #

Contains HTTP errors and parse errors.

Constructors

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

Instances

Instances details

Show KCError Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> KCError -> ShowS # show :: KCError -> String # showList :: [KCError] -> ShowS #
AsError KCError Source #
Instance details Defined in Keycloak.Types Methods _Error :: Prism' KCError Error # _AlgorithmNotImplemented :: Prism' KCError () # _AlgorithmMismatch :: Prism' KCError String # _KeyMismatch :: Prism' KCError Text # _KeySizeTooSmall :: Prism' KCError () # _OtherPrimesNotSupported :: Prism' KCError () # _RSAError :: Prism' KCError Error # _CryptoError :: Prism' KCError CryptoError # _CompactDecodeError :: Prism' KCError CompactDecodeError # _JSONDecodeError :: Prism' KCError String # _NoUsableKeys :: Prism' KCError () # _JWSCritUnprotected :: Prism' KCError () # _JWSNoValidSignatures :: Prism' KCError () # _JWSInvalidSignature :: Prism' KCError () # _JWSNoSignatures :: Prism' KCError () #
AsJWTError KCError Source #
Instance details Defined in Keycloak.Types Methods _JWTError :: Prism' KCError JWTError # _JWSError :: Prism' KCError Error # _JWTClaimsSetDecodeError :: Prism' KCError String # _JWTExpired :: Prism' KCError () # _JWTNotYetValid :: Prism' KCError () # _JWTNotInIssuer :: Prism' KCError () # _JWTNotInAudience :: Prism' KCError () # _JWTIssuedAtFuture :: Prism' KCError () #

data KCConfig Source #

Constructors

KCConfig
Fields _confAdapterConfig :: AdapterConfig _confJWKs :: [JWK]

Instances

Instances details

Generic KCConfig Source #
Instance details Defined in Keycloak.Types Associated Types type Rep KCConfig :: Type -> Type # Methods from :: KCConfig -> Rep KCConfig x # to :: Rep KCConfig x -> KCConfig #
Show KCConfig Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> KCConfig -> ShowS # show :: KCConfig -> String # showList :: [KCConfig] -> ShowS #
Eq KCConfig Source #
Instance details Defined in Keycloak.Types Methods (==) :: KCConfig -> KCConfig -> Bool # (/=) :: KCConfig -> KCConfig -> Bool #
type Rep KCConfig Source #
Instance details Defined in Keycloak.Types type Rep KCConfig = D1 ('MetaData "KCConfig" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'False) (C1 ('MetaCons "KCConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "_confAdapterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AdapterConfig) :*: S1 ('MetaSel ('Just "_confJWKs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [JWK])))

type Realm = Text Source #

type ClientId = Text Source #

type ServerURL = Text Source #

data AdapterConfig Source #

Configuration of Keycloak.

Constructors

AdapterConfig
Fields _confRealm :: Realm realm to use _confAuthServerUrl :: ServerURL Base url where Keycloak resides _confResource :: ClientId client id _confCredentials :: ClientCredentials client secret, found in Client/Credentials tab

Instances

Instances details

FromJSON AdapterConfig Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser AdapterConfig # parseJSONList :: Value -> Parser [AdapterConfig] #
ToJSON AdapterConfig Source #
Instance details Defined in Keycloak.Types Methods toJSON :: AdapterConfig -> Value # toEncoding :: AdapterConfig -> Encoding # toJSONList :: [AdapterConfig] -> Value # toEncodingList :: [AdapterConfig] -> Encoding #
Generic AdapterConfig Source #
Instance details Defined in Keycloak.Types Associated Types type Rep AdapterConfig :: Type -> Type # Methods from :: AdapterConfig -> Rep AdapterConfig x # to :: Rep AdapterConfig x -> AdapterConfig #
Show AdapterConfig Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> AdapterConfig -> ShowS # show :: AdapterConfig -> String # showList :: [AdapterConfig] -> ShowS #
Eq AdapterConfig Source #
Instance details Defined in Keycloak.Types Methods (==) :: AdapterConfig -> AdapterConfig -> Bool # (/=) :: AdapterConfig -> AdapterConfig -> Bool #
type Rep AdapterConfig Source #
Instance details Defined in Keycloak.Types type Rep AdapterConfig = D1 ('MetaData "AdapterConfig" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'False) (C1 ('MetaCons "AdapterConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_confRealm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Realm) :: S1 ('MetaSel ('Just "_confAuthServerUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ServerURL)) :: (S1 ('MetaSel ('Just "_confResource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ClientId) :*: S1 ('MetaSel ('Just "_confCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ClientCredentials))))

data ClientCredentials Source #

Constructors

ClientCredentials
Fields _confSecret :: Text

Instances

Instances details

FromJSON ClientCredentials Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser ClientCredentials # parseJSONList :: Value -> Parser [ClientCredentials] #
ToJSON ClientCredentials Source #
Instance details Defined in Keycloak.Types Methods toJSON :: ClientCredentials -> Value # toEncoding :: ClientCredentials -> Encoding # toJSONList :: [ClientCredentials] -> Value # toEncodingList :: [ClientCredentials] -> Encoding #
Generic ClientCredentials Source #
Instance details Defined in Keycloak.Types Associated Types type Rep ClientCredentials :: Type -> Type # Methods from :: ClientCredentials -> Rep ClientCredentials x # to :: Rep ClientCredentials x -> ClientCredentials #
Show ClientCredentials Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> ClientCredentials -> ShowS # show :: ClientCredentials -> String # showList :: [ClientCredentials] -> ShowS #
Eq ClientCredentials Source #
Instance details Defined in Keycloak.Types Methods (==) :: ClientCredentials -> ClientCredentials -> Bool # (/=) :: ClientCredentials -> ClientCredentials -> Bool #
type Rep ClientCredentials Source #
Instance details Defined in Keycloak.Types type Rep ClientCredentials = D1 ('MetaData "ClientCredentials" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'False) (C1 ('MetaCons "ClientCredentials" 'PrefixI 'True) (S1 ('MetaSel ('Just "_confSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

trainDrop :: Int -> Options Source #

defaultAdapterConfig :: AdapterConfig Source #

Default configuration

runKeycloak :: Monad m => KeycloakT m a -> KCConfig -> m (Either KCError a) Source #

Run a Keycloak monad within IO.

type Path = Text Source #

Token

data TokenRep Source #

Token reply from Keycloak

Constructors

TokenRep
Fields accessToken :: Text expiresIn :: Int refreshExpriresIn :: Int refreshToken :: Text tokenType :: Text notBeforePolicy :: Int sessionState :: Text tokenScope :: Text

Instances

Instances details

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

Permissions

newtype ScopeName Source #

Scope name, such as "houses:view" You need to create the scopes in ClientAuthorization panelAuthorization scopes tab

Constructors

ScopeName
Fields unScopeName :: Text

Instances

Instances details

FromJSON ScopeName Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser ScopeName # parseJSONList :: Value -> Parser [ScopeName] #
ToJSON ScopeName Source #
Instance details Defined in Keycloak.Types Methods toJSON :: ScopeName -> Value # toEncoding :: ScopeName -> Encoding # toJSONList :: [ScopeName] -> Value # toEncodingList :: [ScopeName] -> Encoding #
Generic ScopeName Source #
Instance details Defined in Keycloak.Types Associated Types type Rep ScopeName :: Type -> Type # Methods from :: ScopeName -> Rep ScopeName x # to :: Rep ScopeName x -> ScopeName #
Show ScopeName Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> ScopeName -> ShowS # show :: ScopeName -> String # showList :: [ScopeName] -> ShowS #
Eq ScopeName Source #
Instance details Defined in Keycloak.Types Methods (==) :: ScopeName -> ScopeName -> Bool # (/=) :: ScopeName -> ScopeName -> Bool #
Ord ScopeName Source #
Instance details Defined in Keycloak.Types Methods compare :: ScopeName -> ScopeName -> Ordering # (<) :: ScopeName -> ScopeName -> Bool # (<=) :: ScopeName -> ScopeName -> Bool # (>) :: ScopeName -> ScopeName -> Bool # (>=) :: ScopeName -> ScopeName -> Bool # max :: ScopeName -> ScopeName -> ScopeName # min :: ScopeName -> ScopeName -> ScopeName #
Hashable ScopeName Source #
Instance details Defined in Keycloak.Types Methods hashWithSalt :: Int -> ScopeName -> Int # hash :: ScopeName -> Int #
type Rep ScopeName Source #
Instance details Defined in Keycloak.Types type Rep ScopeName = D1 ('MetaData "ScopeName" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'True) (C1 ('MetaCons "ScopeName" 'PrefixI 'True) (S1 ('MetaSel ('Just "unScopeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype ScopeId Source #

Scope Id

Constructors

ScopeId
Fields unScopeId :: Text

Instances

Instances details

FromJSON ScopeId Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser ScopeId # parseJSONList :: Value -> Parser [ScopeId] #
ToJSON ScopeId Source #
Instance details Defined in Keycloak.Types Methods toJSON :: ScopeId -> Value # toEncoding :: ScopeId -> Encoding # toJSONList :: [ScopeId] -> Value # toEncodingList :: [ScopeId] -> Encoding #
Generic ScopeId Source #
Instance details Defined in Keycloak.Types Associated Types type Rep ScopeId :: Type -> Type # Methods from :: ScopeId -> Rep ScopeId x # to :: Rep ScopeId x -> ScopeId #
Show ScopeId Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> ScopeId -> ShowS # show :: ScopeId -> String # showList :: [ScopeId] -> ShowS #
Eq ScopeId Source #
Instance details Defined in Keycloak.Types Methods (==) :: ScopeId -> ScopeId -> Bool # (/=) :: ScopeId -> ScopeId -> Bool #
type Rep ScopeId Source #
Instance details Defined in Keycloak.Types type Rep ScopeId = D1 ('MetaData "ScopeId" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'True) (C1 ('MetaCons "ScopeId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unScopeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Scope Source #

Keycloak scope

Constructors

Scope
Fields scopeId :: Maybe ScopeId scopeName :: ScopeName

Instances

Instances details

FromJSON Scope Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser Scope # parseJSONList :: Value -> Parser [Scope] #
ToJSON Scope Source #
Instance details Defined in Keycloak.Types Methods toJSON :: Scope -> Value # toEncoding :: Scope -> Encoding # toJSONList :: [Scope] -> Value # toEncodingList :: [Scope] -> Encoding #
Generic Scope Source #
Instance details Defined in Keycloak.Types Associated Types type Rep Scope :: Type -> Type # Methods from :: Scope -> Rep Scope x # to :: Rep Scope x -> Scope #
Show Scope Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> Scope -> ShowS # show :: Scope -> String # showList :: [Scope] -> ShowS #
Eq Scope Source #
Instance details Defined in Keycloak.Types Methods (==) :: Scope -> Scope -> Bool # (/=) :: Scope -> Scope -> Bool #
type Rep Scope Source #
Instance details Defined in Keycloak.Types type Rep Scope = D1 ('MetaData "Scope" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'False) (C1 ('MetaCons "Scope" 'PrefixI 'True) (S1 ('MetaSel ('Just "scopeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ScopeId)) :*: S1 ('MetaSel ('Just "scopeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScopeName)))

data PermReq Source #

permission request You can perform a request on a specific resourse, or on all resources. You can request permission on multiple scopes at once.

Constructors

PermReq
Fields permReqResourceId :: Maybe ResourceId Requested ressource Ids. Nothing means "All resources". permReqScopes :: [ScopeName] Scopes requested. [] means "all scopes".

Instances

Instances details

Generic PermReq Source #
Instance details Defined in Keycloak.Types Associated Types type Rep PermReq :: Type -> Type # Methods from :: PermReq -> Rep PermReq x # to :: Rep PermReq x -> PermReq #
Show PermReq Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> PermReq -> ShowS # show :: PermReq -> String # showList :: [PermReq] -> ShowS #
Eq PermReq Source #
Instance details Defined in Keycloak.Types Methods (==) :: PermReq -> PermReq -> Bool # (/=) :: PermReq -> PermReq -> Bool #
Ord PermReq Source #
Instance details Defined in Keycloak.Types Methods compare :: PermReq -> PermReq -> Ordering # (<) :: PermReq -> PermReq -> Bool # (<=) :: PermReq -> PermReq -> Bool # (>) :: PermReq -> PermReq -> Bool # (>=) :: PermReq -> PermReq -> Bool # max :: PermReq -> PermReq -> PermReq # min :: PermReq -> PermReq -> PermReq #
Hashable PermReq Source #
Instance details Defined in Keycloak.Types Methods hashWithSalt :: Int -> PermReq -> Int # hash :: PermReq -> Int #
type Rep PermReq Source #
Instance details Defined in Keycloak.Types type Rep PermReq = D1 ('MetaData "PermReq" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'False) (C1 ('MetaCons "PermReq" 'PrefixI 'True) (S1 ('MetaSel ('Just "permReqResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ResourceId)) :*: S1 ('MetaSel ('Just "permReqScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ScopeName])))

data Permission Source #

Keycloak permission on a resource Returned by Keycloak after a permission request is made.

Constructors

Permission
Fields permRsid :: Maybe ResourceId Resource ID, can be Nothing in case of scope-only permission request permRsname :: Maybe ResourceName Resource Name, can be Nothing in case of scope-only permission request permScopes :: [ScopeName] Scopes that are accessible (Non empty)

Instances

Instances details

FromJSON Permission Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser Permission # parseJSONList :: Value -> Parser [Permission] #
ToJSON Permission Source #
Instance details Defined in Keycloak.Types Methods toJSON :: Permission -> Value # toEncoding :: Permission -> Encoding # toJSONList :: [Permission] -> Value # toEncodingList :: [Permission] -> Encoding #
Generic Permission Source #
Instance details Defined in Keycloak.Types Associated Types type Rep Permission :: Type -> Type # Methods from :: Permission -> Rep Permission x # to :: Rep Permission x -> Permission #
Show Permission Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> Permission -> ShowS # show :: Permission -> String # showList :: [Permission] -> ShowS #
Eq Permission Source #
Instance details Defined in Keycloak.Types Methods (==) :: Permission -> Permission -> Bool # (/=) :: Permission -> Permission -> Bool #
type Rep Permission Source #
Instance details Defined in Keycloak.Types type Rep Permission = D1 ('MetaData "Permission" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'False) (C1 ('MetaCons "Permission" 'PrefixI 'True) (S1 ('MetaSel ('Just "permRsid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ResourceId)) :: (S1 ('MetaSel ('Just "permRsname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ResourceName)) :: S1 ('MetaSel ('Just "permScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ScopeName]))))

User

type Username = Text Source #

type Password = Text Source #

type First = Int Source #

type Max = Int Source #

newtype UserId Source #

Id of a user

Constructors

UserId
Fields unUserId :: Text

Instances

Instances details

FromJSON UserId Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser UserId # parseJSONList :: Value -> Parser [UserId] #
ToJSON UserId Source #
Instance details Defined in Keycloak.Types Methods toJSON :: UserId -> Value # toEncoding :: UserId -> Encoding # toJSONList :: [UserId] -> Value # toEncodingList :: [UserId] -> Encoding #
Generic UserId Source #
Instance details Defined in Keycloak.Types Associated Types type Rep UserId :: Type -> Type # Methods from :: UserId -> Rep UserId x # to :: Rep UserId x -> UserId #
Show UserId Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> UserId -> ShowS # show :: UserId -> String # showList :: [UserId] -> ShowS #
Eq UserId Source #
Instance details Defined in Keycloak.Types Methods (==) :: UserId -> UserId -> Bool # (/=) :: UserId -> UserId -> Bool #
type Rep UserId Source #
Instance details Defined in Keycloak.Types type Rep UserId = D1 ('MetaData "UserId" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'True) (C1 ('MetaCons "UserId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data User Source #

User

Constructors

User
Fields userId :: Maybe UserId The unique user ID userUsername :: Username Username userFirstName :: Maybe Text First name userLastName :: Maybe Text Last name userEmail :: Maybe Text Email userAttributes :: Maybe (Map Text Value)

Instances

Instances details

FromJSON User Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #
ToJSON User Source #
Instance details Defined in Keycloak.Types Methods toJSON :: User -> Value # toEncoding :: User -> Encoding # toJSONList :: [User] -> Value # toEncodingList :: [User] -> Encoding #
Generic User Source #
Instance details Defined in Keycloak.Types Associated Types type Rep User :: Type -> Type # Methods from :: User -> Rep User x # to :: Rep User x -> User #
Show User Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
Eq User Source #
Instance details Defined in Keycloak.Types Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
type Rep User Source #
Instance details Defined in Keycloak.Types type Rep User = D1 ('MetaData "User" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'False) (C1 ('MetaCons "User" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UserId)) :: (S1 ('MetaSel ('Just "userUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Username) :: S1 ('MetaSel ('Just "userFirstName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "userLastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value)))))))

unCapitalize :: String -> String Source #

Owner

data Owner Source #

A resource owner

Constructors

Owner
Fields ownId :: Maybe Text ownName :: Maybe Username

Instances

Instances details

FromJSON Owner Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser Owner # parseJSONList :: Value -> Parser [Owner] #
ToJSON Owner Source #
Instance details Defined in Keycloak.Types Methods toJSON :: Owner -> Value # toEncoding :: Owner -> Encoding # toJSONList :: [Owner] -> Value # toEncodingList :: [Owner] -> Encoding #
Generic Owner Source #
Instance details Defined in Keycloak.Types Associated Types type Rep Owner :: Type -> Type # Methods from :: Owner -> Rep Owner x # to :: Rep Owner x -> Owner #
Show Owner Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> Owner -> ShowS # show :: Owner -> String # showList :: [Owner] -> ShowS #
type Rep Owner Source #
Instance details Defined in Keycloak.Types type Rep Owner = D1 ('MetaData "Owner" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'False) (C1 ('MetaCons "Owner" 'PrefixI 'True) (S1 ('MetaSel ('Just "ownId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ownName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Username))))

Resource

type ResourceName = Text Source #

type ResourceType = Text Source #

newtype ResourceId Source #

A resource Id

Constructors

ResourceId
Fields unResId :: Text

Instances

Instances details

FromJSON ResourceId Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser ResourceId # parseJSONList :: Value -> Parser [ResourceId] #
ToJSON ResourceId Source #
Instance details Defined in Keycloak.Types Methods toJSON :: ResourceId -> Value # toEncoding :: ResourceId -> Encoding # toJSONList :: [ResourceId] -> Value # toEncodingList :: [ResourceId] -> Encoding #
Generic ResourceId Source #
Instance details Defined in Keycloak.Types Associated Types type Rep ResourceId :: Type -> Type # Methods from :: ResourceId -> Rep ResourceId x # to :: Rep ResourceId x -> ResourceId #
Show ResourceId Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> ResourceId -> ShowS # show :: ResourceId -> String # showList :: [ResourceId] -> ShowS #
Eq ResourceId Source #
Instance details Defined in Keycloak.Types Methods (==) :: ResourceId -> ResourceId -> Bool # (/=) :: ResourceId -> ResourceId -> Bool #
Ord ResourceId Source #
Instance details Defined in Keycloak.Types Methods compare :: ResourceId -> ResourceId -> Ordering # (<) :: ResourceId -> ResourceId -> Bool # (<=) :: ResourceId -> ResourceId -> Bool # (>) :: ResourceId -> ResourceId -> Bool # (>=) :: ResourceId -> ResourceId -> Bool # max :: ResourceId -> ResourceId -> ResourceId # min :: ResourceId -> ResourceId -> ResourceId #
Hashable ResourceId Source #
Instance details Defined in Keycloak.Types Methods hashWithSalt :: Int -> ResourceId -> Int # hash :: ResourceId -> Int #
type Rep ResourceId Source #
Instance details Defined in Keycloak.Types type Rep ResourceId = D1 ('MetaData "ResourceId" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'True) (C1 ('MetaCons "ResourceId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unResId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Resource Source #

A complete resource Resources are created in Keycloak in Client/ You can create resources in ClientAuthorization panelResources scopes tab

Constructors

Resource

Fields

resId :: Maybe ResourceId
the Keycloak resource ID
resName :: ResourceName
the Keycloak resource name
resType :: Maybe ResourceType
Optional resource type
resUris :: [Text]
Optional resource URI
resScopes :: [Scope]
All the possible scopes for that resource
resOwner :: Owner
The Owner or the resource
resOwnerManagedAccess :: Bool
Whether the owner can manage his own resources (e.g. resource sharing with others)
resAttributes :: [Attribute]
Resource attributes

Instances

Instances details

FromJSON Resource Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser Resource # parseJSONList :: Value -> Parser [Resource] #
ToJSON Resource Source #
Instance details Defined in Keycloak.Types Methods toJSON :: Resource -> Value # toEncoding :: Resource -> Encoding # toJSONList :: [Resource] -> Value # toEncodingList :: [Resource] -> Encoding #
Generic Resource Source #
Instance details Defined in Keycloak.Types Associated Types type Rep Resource :: Type -> Type # Methods from :: Resource -> Rep Resource x # to :: Rep Resource x -> Resource #
Show Resource Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> Resource -> ShowS # show :: Resource -> String # showList :: [Resource] -> ShowS #
type Rep Resource Source #
Instance details Defined in Keycloak.Types type Rep Resource = D1 ('MetaData "Resource" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'False) (C1 ('MetaCons "Resource" 'PrefixI 'True) (((S1 ('MetaSel ('Just "resId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ResourceId)) :: S1 ('MetaSel ('Just "resName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ResourceName)) :: (S1 ('MetaSel ('Just "resType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ResourceType)) :: S1 ('MetaSel ('Just "resUris") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]))) :: ((S1 ('MetaSel ('Just "resScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Scope]) :: S1 ('MetaSel ('Just "resOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Owner)) :: (S1 ('MetaSel ('Just "resOwnerManagedAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "resAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Attribute])))))

data Attribute Source #

A resource attribute

Constructors

Attribute
Fields attName :: Text attValues :: [Text]

Instances

Instances details

FromJSON Attribute Source #
Instance details Defined in Keycloak.Types Methods parseJSON :: Value -> Parser Attribute # parseJSONList :: Value -> Parser [Attribute] #
ToJSON Attribute Source #
Instance details Defined in Keycloak.Types Methods toJSON :: Attribute -> Value # toEncoding :: Attribute -> Encoding # toJSONList :: [Attribute] -> Value # toEncodingList :: [Attribute] -> Encoding #
Generic Attribute Source #
Instance details Defined in Keycloak.Types Associated Types type Rep Attribute :: Type -> Type # Methods from :: Attribute -> Rep Attribute x # to :: Rep Attribute x -> Attribute #
Show Attribute Source #
Instance details Defined in Keycloak.Types Methods showsPrec :: Int -> Attribute -> ShowS # show :: Attribute -> String # showList :: [Attribute] -> ShowS #
type Rep Attribute Source #
Instance details Defined in Keycloak.Types type Rep Attribute = D1 ('MetaData "Attribute" "Keycloak.Types" "keycloak-hs-3.0.2-1D5hbGS3N1dGc3ClrNAkve" 'False) (C1 ('MetaCons "Attribute" 'PrefixI 'True) (S1 ('MetaSel ('Just "attName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "attValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

confJWKs :: Lens' KCConfig [JWK] Source #

confAdapterConfig :: Lens' KCConfig AdapterConfig Source #

confSecret :: Iso' ClientCredentials Text Source #

confResource :: Lens' AdapterConfig ClientId Source #

confRealm :: Lens' AdapterConfig Realm Source #

confCredentials :: Lens' AdapterConfig ClientCredentials Source #

confAuthServerUrl :: Lens' AdapterConfig ServerURL Source #