gogol-admin-directory-0.4.0: Google Admin Directory SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Directory.Groups.List

Contents

Description

Retrieve all groups of a domain or of a user given a userKey (paginated)

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

Synopsis

REST Resource

type GroupsListResource = "admin" :> ("directory" :> ("v1" :> ("groups" :> (QueryParam "orderBy" GroupsListOrderBy :> (QueryParam "domain" Text :> (QueryParam "sortOrder" GroupsListSortOrder :> (QueryParam "customer" Text :> (QueryParam "query" Text :> (QueryParam "pageToken" Text :> (QueryParam "userKey" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Groups)))))))))))) Source #

A resource alias for directory.groups.list method which the GroupsList request conforms to.

Creating a Request

groupsList :: GroupsList Source #

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

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

data GroupsList Source #

Retrieve all groups of a domain or of a user given a userKey (paginated)

See: groupsList smart constructor.

Instances
Eq GroupsList Source # 
Instance details

Defined in Network.Google.Resource.Directory.Groups.List

Data GroupsList Source # 
Instance details

Defined in Network.Google.Resource.Directory.Groups.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GroupsList -> c GroupsList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GroupsList #

toConstr :: GroupsList -> Constr #

dataTypeOf :: GroupsList -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GroupsList) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GroupsList) #

gmapT :: (forall b. Data b => b -> b) -> GroupsList -> GroupsList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GroupsList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GroupsList -> r #

gmapQ :: (forall d. Data d => d -> u) -> GroupsList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GroupsList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GroupsList -> m GroupsList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GroupsList -> m GroupsList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GroupsList -> m GroupsList #

Show GroupsList Source # 
Instance details

Defined in Network.Google.Resource.Directory.Groups.List

Generic GroupsList Source # 
Instance details

Defined in Network.Google.Resource.Directory.Groups.List

Associated Types

type Rep GroupsList :: Type -> Type #

GoogleRequest GroupsList Source # 
Instance details

Defined in Network.Google.Resource.Directory.Groups.List

Associated Types

type Rs GroupsList :: Type #

type Scopes GroupsList :: [Symbol] #

type Rep GroupsList Source # 
Instance details

Defined in Network.Google.Resource.Directory.Groups.List

type Scopes GroupsList Source # 
Instance details

Defined in Network.Google.Resource.Directory.Groups.List

type Scopes GroupsList = "https://www.googleapis.com/auth/admin.directory.group" ': ("https://www.googleapis.com/auth/admin.directory.group.readonly" ': ([] :: [Symbol]))
type Rs GroupsList Source # 
Instance details

Defined in Network.Google.Resource.Directory.Groups.List

Request Lenses

glOrderBy :: Lens' GroupsList (Maybe GroupsListOrderBy) Source #

Column to use for sorting results

glDomain :: Lens' GroupsList (Maybe Text) Source #

Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.

glSortOrder :: Lens' GroupsList (Maybe GroupsListSortOrder) Source #

Whether to return results in ascending or descending order. Only of use when orderBy is also used

glCustomer :: Lens' GroupsList (Maybe Text) Source #

Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.

glQuery :: Lens' GroupsList (Maybe Text) Source #

Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups

glPageToken :: Lens' GroupsList (Maybe Text) Source #

Token to specify next page in the list

glUserKey :: Lens' GroupsList (Maybe Text) Source #

Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object

glMaxResults :: Lens' GroupsList (Maybe Int32) Source #

Maximum number of results to return. Default is 200