Network.Google.Resource.Directory.Groups.List

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

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

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

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

Creating a Request

groupsList :: GroupsList

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:

• glOrderBy
• glDomain
• glSortOrder
• glCustomer
• glQuery
• glPageToken
• glUserKey
• glMaxResults

data GroupsList

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

See: groupsList smart constructor.

Instances

Eq GroupsList

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

Methods

(==) :: GroupsList -> GroupsList -> Bool

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

Data GroupsList

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

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

Methods

showsPrec :: Int -> GroupsList -> ShowS

show :: GroupsList -> String

showList :: [GroupsList] -> ShowS

Generic GroupsList

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

Associated Types

type Rep GroupsList :: Type -> Type

Methods

from :: GroupsList -> Rep GroupsList x

to :: Rep GroupsList x -> GroupsList

GoogleRequest GroupsList

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

Associated Types

type Rs GroupsList :: Type

type Scopes GroupsList :: [Symbol]

Methods

requestClient :: GroupsList -> GClient (Rs GroupsList)

type Rep GroupsList

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

type Rep GroupsList = D1 (MetaData "GroupsList" "Network.Google.Resource.Directory.Groups.List" "gogol-admin-directory-0.4.0-18Kt4WHsDGO3AIyYatQRRN" False) (C1 (MetaCons "GroupsList'" PrefixI True) (((S1 (MetaSel (Just "_glOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GroupsListOrderBy)) :*: S1 (MetaSel (Just "_glDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_glSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GroupsListSortOrder)) :*: S1 (MetaSel (Just "_glCustomer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_glQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_glPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_glUserKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_glMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))

type Scopes GroupsList

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

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

type Rs GroupsList = Groups

Request Lenses

glOrderBy :: Lens' GroupsList (Maybe GroupsListOrderBy)

Column to use for sorting results

glDomain :: Lens' GroupsList (Maybe Text)

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)

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

glCustomer :: Lens' GroupsList (Maybe Text)

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)

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)

Token to specify next page in the list

glUserKey :: Lens' GroupsList (Maybe Text)

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)

Maximum number of results to return. Default is 200