Web.Scim.Class.Group

Documentation

data GroupSite tag route

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

Generic (GroupSite tag route)

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)

Defined in Web.Scim.Class.Group

type Rep (GroupSite tag route) = D1 ('MetaData "GroupSite" "Web.Scim.Class.Group" "hscim-0.3.6-JBBH5QJtoVCBhDdsGW2kZ7" '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

Methods

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

Get all groups.

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

Get a single group by ID.

Should throw notFound if the group does not.

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

Create a new group.

Should throw conflict if uniqueness constraints are violated.

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

Overwrite an existing group.

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

patchGroup

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 ()

Delete a group.

Should throw notFound if the group does not exist.

Instances

GroupDB Mock TestServer

Defined in Web.Scim.Server.Mock

Methods

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

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

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

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

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

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

class GroupTypes tag

Configurable parts of Group.

Associated Types

type GroupId tag

Group ID type.

Instances

GroupTypes Mock

Defined in Web.Scim.Server.Mock

Associated Types

type GroupId Mock

GroupTypes (TestTag id authData authInfo userExtra)

Defined in Web.Scim.Test.Util

Associated Types

type GroupId (TestTag id authData authInfo userExtra)

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

data Group

Constructors

Group

Fields

• schemas :: [Schema]
• displayName :: Text
• members :: [Member]

Instances

Eq Group

Defined in Web.Scim.Class.Group

Methods

(==) :: Group -> Group -> Bool

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

Show Group

Defined in Web.Scim.Class.Group

Methods

showsPrec :: Int -> Group -> ShowS

show :: Group -> String

showList :: [Group] -> ShowS

Generic Group

Defined in Web.Scim.Class.Group

Associated Types

type Rep Group :: Type -> Type

Methods

from :: Group -> Rep Group x

to :: Rep Group x -> Group

ToJSON Group

Defined in Web.Scim.Class.Group

Methods

toJSON :: Group -> Value

toEncoding :: Group -> Encoding

toJSONList :: [Group] -> Value

toEncodingList :: [Group] -> Encoding

FromJSON Group

Defined in Web.Scim.Class.Group

Methods

parseJSON :: Value -> Parser Group

parseJSONList :: Value -> Parser [Group]

type Rep Group

Defined in Web.Scim.Class.Group

type Rep Group

data Member

Constructors

Member

Fields

• value :: Text
• typ :: Text
• ref :: Text

Instances

Eq Member

Defined in Web.Scim.Class.Group

Methods

(==) :: Member -> Member -> Bool

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

Show Member

Defined in Web.Scim.Class.Group

Methods

showsPrec :: Int -> Member -> ShowS

show :: Member -> String

showList :: [Member] -> ShowS

Generic Member

Defined in Web.Scim.Class.Group

Associated Types

type Rep Member :: Type -> Type

Methods

from :: Member -> Rep Member x

to :: Rep Member x -> Member

ToJSON Member

Defined in Web.Scim.Class.Group

Methods

toJSON :: Member -> Value

toEncoding :: Member -> Encoding

toJSONList :: [Member] -> Value

toEncodingList :: [Member] -> Encoding

FromJSON Member

Defined in Web.Scim.Class.Group

Methods

parseJSON :: Value -> Parser Member

parseJSONList :: Value -> Parser [Member]

type Rep Member

Defined in Web.Scim.Class.Group

type Rep Member = D1 ('MetaData "Member" "Web.Scim.Class.Group" "hscim-0.3.6-JBBH5QJtoVCBhDdsGW2kZ7" '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. (Show (GroupId tag), GroupDB tag m) => Maybe (AuthData tag) -> GroupSite tag (AsServerT (ScimHandler m))