Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Scim.Class.Group

Synopsis

data GroupSite tag route = GroupSite {
- gsGetGroups :: route :- Get '[SCIM] (ListResponse (StoredGroup tag))
- gsGetGroup :: route :- (Capture "id" (GroupId tag) :> Get '[SCIM] (StoredGroup tag))
- gsPostGroup :: route :- (ReqBody '[SCIM] Group :> PostCreated '[SCIM] (StoredGroup tag))
- gsPutGroup :: route :- (Capture "id" (GroupId tag) :> (ReqBody '[SCIM] Group :> Put '[SCIM] (StoredGroup tag)))
- gsPatchGroup :: route :- (Capture "id" (GroupId tag) :> (ReqBody '[SCIM] Value :> Patch '[SCIM] (StoredGroup tag)))
- gsDeleteGroup :: route :- (Capture "id" (GroupId tag) :> DeleteNoContent)
}
class (Monad m, GroupTypes tag, AuthDB tag m) => GroupDB tag m where
- getGroups :: AuthInfo tag -> ScimHandler m (ListResponse (StoredGroup tag))
- getGroup :: AuthInfo tag -> GroupId tag -> ScimHandler m (StoredGroup tag)
- postGroup :: AuthInfo tag -> Group -> ScimHandler m (StoredGroup tag)
- putGroup :: AuthInfo tag -> GroupId tag -> Group -> ScimHandler m (StoredGroup tag)
- patchGroup :: AuthInfo tag -> GroupId tag -> Value -> ScimHandler m (StoredGroup tag)
- deleteGroup :: AuthInfo tag -> GroupId tag -> ScimHandler m ()
class GroupTypes tag where
- type GroupId tag
type StoredGroup tag = WithMeta (WithId (GroupId tag) Group)
data Group = Group {
- schemas :: [Schema]
- displayName :: Text
- members :: [Member]
}
data Member = Member {
- value :: Text
- typ :: Text
- ref :: Text
}
groupServer :: forall tag m. GroupDB tag m => Maybe (AuthData tag) -> GroupSite tag (AsServerT (ScimHandler m))

Documentation

data GroupSite tag route Source #

Constructors

GroupSite

Fields

gsGetGroups :: route :- Get '[SCIM] (ListResponse (StoredGroup tag))
gsGetGroup :: route :- (Capture "id" (GroupId tag) :> Get '[SCIM] (StoredGroup tag))
gsPostGroup :: route :- (ReqBody '[SCIM] Group :> PostCreated '[SCIM] (StoredGroup tag))
gsPutGroup :: route :- (Capture "id" (GroupId tag) :> (ReqBody '[SCIM] Group :> Put '[SCIM] (StoredGroup tag)))
gsPatchGroup :: route :- (Capture "id" (GroupId tag) :> (ReqBody '[SCIM] Value :> Patch '[SCIM] (StoredGroup tag)))
gsDeleteGroup :: route :- (Capture "id" (GroupId tag) :> DeleteNoContent)

Instances

Instances details

Generic (GroupSite tag route) Source #
Instance details Defined in Web.Scim.Class.Group Associated Types type Rep (GroupSite tag route) :: Type -> Type # Methods from :: GroupSite tag route -> Rep (GroupSite tag route) x # to :: Rep (GroupSite tag route) x -> GroupSite tag route #
type Rep (GroupSite tag route) Source #
Instance details Defined in Web.Scim.Class.Group type Rep (GroupSite tag route) = D1 ('MetaData "GroupSite" "Web.Scim.Class.Group" "hscim-0.4.0.4-2j6MXcQGp1TDKeruswPvhg" 'False) (C1 ('MetaCons "GroupSite" 'PrefixI 'True) ((S1 ('MetaSel ('Just "gsGetGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- Get '[SCIM] (ListResponse (StoredGroup tag)))) :: (S1 ('MetaSel ('Just "gsGetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Capture "id" (GroupId tag) :> Get '[SCIM] (StoredGroup tag)))) :: S1 ('MetaSel ('Just "gsPostGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (ReqBody '[SCIM] Group :> PostCreated '[SCIM] (StoredGroup tag)))))) :: (S1 ('MetaSel ('Just "gsPutGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Capture "id" (GroupId tag) :> (ReqBody '[SCIM] Group :> Put '[SCIM] (StoredGroup tag))))) :: (S1 ('MetaSel ('Just "gsPatchGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Capture "id" (GroupId tag) :> (ReqBody '[SCIM] Value :> Patch '[SCIM] (StoredGroup tag))))) :*: S1 ('MetaSel ('Just "gsDeleteGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Capture "id" (GroupId tag) :> DeleteNoContent)))))))

class (Monad m, GroupTypes tag, AuthDB tag m) => GroupDB tag m where Source #

Methods

getGroups :: AuthInfo tag -> ScimHandler m (ListResponse (StoredGroup tag)) Source #

Get all groups.

getGroup :: AuthInfo tag -> GroupId tag -> ScimHandler m (StoredGroup tag) Source #

Get a single group by ID.

Should throw notFound if the group does not.

postGroup :: AuthInfo tag -> Group -> ScimHandler m (StoredGroup tag) Source #

Create a new group.

Should throw conflict if uniqueness constraints are violated.

putGroup :: AuthInfo tag -> GroupId tag -> Group -> ScimHandler m (StoredGroup tag) Source #

Overwrite an existing group.

Should throw notFound if the group does not exist, and conflict if uniqueness constraints are violated.

patchGroup Source #

Arguments

:: AuthInfo tag
-> GroupId tag
-> Value	PATCH payload
-> ScimHandler m (StoredGroup tag)

Modify an existing group.

Should throw notFound if the group doesn't exist, and conflict if uniqueness constraints are violated.

FUTUREWORK: add types for PATCH (instead of Value). See https://tools.ietf.org/html/rfc7644#section-3.5.2

deleteGroup :: AuthInfo tag -> GroupId tag -> ScimHandler m () Source #

Delete a group.

Should throw notFound if the group does not exist.

Instances

Instances details

GroupDB Mock TestServer Source #

Instance details

Defined in Web.Scim.Server.Mock

Methods

getGroups :: AuthInfo Mock -> ScimHandler TestServer (ListResponse (StoredGroup Mock)) Source #

getGroup :: AuthInfo Mock -> GroupId Mock -> ScimHandler TestServer (StoredGroup Mock) Source #

postGroup :: AuthInfo Mock -> Group -> ScimHandler TestServer (StoredGroup Mock) Source #

putGroup :: AuthInfo Mock -> GroupId Mock -> Group -> ScimHandler TestServer (StoredGroup Mock) Source #

patchGroup :: AuthInfo Mock -> GroupId Mock -> Value -> ScimHandler TestServer (StoredGroup Mock) Source #

deleteGroup :: AuthInfo Mock -> GroupId Mock -> ScimHandler TestServer () Source #

class GroupTypes tag Source #

Configurable parts of Group.

Associated Types

type GroupId tag Source #

Group ID type.

Instances

Instances details

GroupTypes Mock Source #
Instance details Defined in Web.Scim.Server.Mock Associated Types type GroupId Mock Source #
GroupTypes (TestTag id authData authInfo userExtra) Source #
Instance details Defined in Web.Scim.Test.Util Associated Types type GroupId (TestTag id authData authInfo userExtra) Source #

type StoredGroup tag = WithMeta (WithId (GroupId tag) Group) Source #

data Group Source #

Constructors

Group
Fields schemas :: [Schema] displayName :: Text members :: [Member]

Instances

Instances details

FromJSON Group Source #
Instance details Defined in Web.Scim.Class.Group Methods parseJSON :: Value -> Parser Group # parseJSONList :: Value -> Parser [Group] #
ToJSON Group Source #
Instance details Defined in Web.Scim.Class.Group Methods toJSON :: Group -> Value # toEncoding :: Group -> Encoding # toJSONList :: [Group] -> Value # toEncodingList :: [Group] -> Encoding #
Generic Group Source #
Instance details Defined in Web.Scim.Class.Group Associated Types type Rep Group :: Type -> Type # Methods from :: Group -> Rep Group x # to :: Rep Group x -> Group #
Show Group Source #
Instance details Defined in Web.Scim.Class.Group Methods showsPrec :: Int -> Group -> ShowS # show :: Group -> String # showList :: [Group] -> ShowS #
Eq Group Source #
Instance details Defined in Web.Scim.Class.Group Methods (==) :: Group -> Group -> Bool # (/=) :: Group -> Group -> Bool #
type Rep Group Source #
Instance details Defined in Web.Scim.Class.Group type Rep Group

data Member Source #

Constructors

Member
Fields value :: Text typ :: Text ref :: Text

Instances

Instances details

FromJSON Member Source #
Instance details Defined in Web.Scim.Class.Group Methods parseJSON :: Value -> Parser Member # parseJSONList :: Value -> Parser [Member] #
ToJSON Member Source #
Instance details Defined in Web.Scim.Class.Group Methods toJSON :: Member -> Value # toEncoding :: Member -> Encoding # toJSONList :: [Member] -> Value # toEncodingList :: [Member] -> Encoding #
Generic Member Source #
Instance details Defined in Web.Scim.Class.Group Associated Types type Rep Member :: Type -> Type # Methods from :: Member -> Rep Member x # to :: Rep Member x -> Member #
Show Member Source #
Instance details Defined in Web.Scim.Class.Group Methods showsPrec :: Int -> Member -> ShowS # show :: Member -> String # showList :: [Member] -> ShowS #
Eq Member Source #
Instance details Defined in Web.Scim.Class.Group Methods (==) :: Member -> Member -> Bool # (/=) :: Member -> Member -> Bool #
type Rep Member Source #
Instance details Defined in Web.Scim.Class.Group type Rep Member = D1 ('MetaData "Member" "Web.Scim.Class.Group" "hscim-0.4.0.4-2j6MXcQGp1TDKeruswPvhg" 'False) (C1 ('MetaCons "Member" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "typ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "ref") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

groupServer :: forall tag m. GroupDB tag m => Maybe (AuthData tag) -> GroupSite tag (AsServerT (ScimHandler m)) Source #