Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Directory.Members.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Retrieve all members in a group (paginated)

See: Admin Directory API Reference for directory.members.list.

Synopsis

type MembersListResource = "admin" :> ("directory" :> ("v1" :> ("groups" :> (Capture "groupKey" Text :> ("members" :> (QueryParam "roles" Text :> (QueryParam "pageToken" Text :> (QueryParam "includeDerivedMembership" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Members))))))))))
membersList :: Text -> MembersList
data MembersList
mlRoles :: Lens' MembersList (Maybe Text)
mlGroupKey :: Lens' MembersList Text
mlPageToken :: Lens' MembersList (Maybe Text)
mlIncludeDerivedMembership :: Lens' MembersList (Maybe Bool)
mlMaxResults :: Lens' MembersList (Maybe Int32)

REST Resource

type MembersListResource = "admin" :> ("directory" :> ("v1" :> ("groups" :> (Capture "groupKey" Text :> ("members" :> (QueryParam "roles" Text :> (QueryParam "pageToken" Text :> (QueryParam "includeDerivedMembership" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Members)))))))))) Source #

A resource alias for directory.members.list method which the MembersList request conforms to.

Creating a Request

membersList Source #

Arguments

:: Text	`mlGroupKey`
-> MembersList

Creates a value of MembersList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data MembersList Source #

Retrieve all members in a group (paginated)

See: membersList smart constructor.

Instances

Eq MembersList Source #
Instance details Defined in Network.Google.Resource.Directory.Members.List Methods (==) :: MembersList -> MembersList -> Bool # (/=) :: MembersList -> MembersList -> Bool #
Data MembersList Source #
Instance details Defined in Network.Google.Resource.Directory.Members.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MembersList -> c MembersList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MembersList # toConstr :: MembersList -> Constr # dataTypeOf :: MembersList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MembersList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MembersList) # gmapT :: (forall b. Data b => b -> b) -> MembersList -> MembersList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MembersList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MembersList -> r # gmapQ :: (forall d. Data d => d -> u) -> MembersList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> MembersList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> MembersList -> m MembersList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MembersList -> m MembersList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MembersList -> m MembersList #
Show MembersList Source #
Instance details Defined in Network.Google.Resource.Directory.Members.List Methods showsPrec :: Int -> MembersList -> ShowS # show :: MembersList -> String # showList :: [MembersList] -> ShowS #
Generic MembersList Source #
Instance details Defined in Network.Google.Resource.Directory.Members.List Associated Types type Rep MembersList :: Type -> Type # Methods from :: MembersList -> Rep MembersList x # to :: Rep MembersList x -> MembersList #
GoogleRequest MembersList Source #
Instance details Defined in Network.Google.Resource.Directory.Members.List Associated Types type Rs MembersList :: Type # type Scopes MembersList :: [Symbol] # Methods requestClient :: MembersList -> GClient (Rs MembersList) #
type Rep MembersList Source #
Instance details Defined in Network.Google.Resource.Directory.Members.List type Rep MembersList = D1 (MetaData "MembersList" "Network.Google.Resource.Directory.Members.List" "gogol-admin-directory-0.4.0-18Kt4WHsDGO3AIyYatQRRN" False) (C1 (MetaCons "MembersList'" PrefixI True) ((S1 (MetaSel (Just "_mlRoles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_mlGroupKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_mlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_mlIncludeDerivedMembership") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_mlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))
type Scopes MembersList Source #
Instance details Defined in Network.Google.Resource.Directory.Members.List type Scopes MembersList = "https://www.googleapis.com/auth/admin.directory.group" ': ("https://www.googleapis.com/auth/admin.directory.group.member" ': ("https://www.googleapis.com/auth/admin.directory.group.member.readonly" ': ("https://www.googleapis.com/auth/admin.directory.group.readonly" ': ([] :: [Symbol]))))
type Rs MembersList Source #
Instance details Defined in Network.Google.Resource.Directory.Members.List type Rs MembersList = Members

Request Lenses

mlRoles :: Lens' MembersList (Maybe Text) Source #

Comma separated role values to filter list results on.

mlGroupKey :: Lens' MembersList Text Source #

Email or immutable ID of the group

mlPageToken :: Lens' MembersList (Maybe Text) Source #

Token to specify next page in the list

mlIncludeDerivedMembership :: Lens' MembersList (Maybe Bool) Source #

Whether to list indirect memberships. Default: false.

mlMaxResults :: Lens' MembersList (Maybe Int32) Source #

Maximum number of results to return. Default is 200