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 |
Retrieve all groups in a domain (paginated)
See: Admin Directory API Reference for directory.groups.list
.
- type GroupsListResource = "admin" :> ("directory" :> ("v1" :> ("groups" :> (QueryParam "domain" Text :> (QueryParam "customer" Text :> (QueryParam "pageToken" Text :> (QueryParam "userKey" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Groups)))))))))
- groupsList :: GroupsList
- data GroupsList
- glDomain :: Lens' GroupsList (Maybe Text)
- glCustomer :: Lens' GroupsList (Maybe Text)
- glPageToken :: Lens' GroupsList (Maybe Text)
- glUserKey :: Lens' GroupsList (Maybe Text)
- glMaxResults :: Lens' GroupsList (Maybe Int32)
REST Resource
type GroupsListResource = "admin" :> ("directory" :> ("v1" :> ("groups" :> (QueryParam "domain" Text :> (QueryParam "customer" 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 in a domain (paginated)
See: groupsList
smart constructor.
Eq GroupsList Source # | |
Data GroupsList Source # | |
Show GroupsList Source # | |
Generic GroupsList Source # | |
GoogleRequest GroupsList Source # | |
type Rep GroupsList Source # | |
type Scopes GroupsList Source # | |
type Rs GroupsList Source # | |
Request Lenses
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.
glCustomer :: Lens' GroupsList (Maybe Text) Source #
Immutable id of the Google Apps account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.
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