Network.Google.Resource.Directory.Users.List

Retrieve either deleted users or all users in a domain (paginated)

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

REST Resource

type UsersListResource = "admin" :> ("directory" :> ("v1" :> ("users" :> (QueryParam "event" UsersListEvent :> (QueryParam "orderBy" UsersListOrderBy :> (QueryParam "viewType" UsersListViewType :> (QueryParam "customFieldMask" Text :> (QueryParam "domain" Text :> (QueryParam "showDeleted" Text :> (QueryParam "sortOrder" UsersListSortOrder :> (QueryParam "customer" Text :> (QueryParam "query" Text :> (QueryParam "projection" UsersListProjection :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Users))))))))))))))))

A resource alias for directory.users.list method which the UsersList request conforms to.

Creating a Request

usersList :: UsersList

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

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

• ulEvent
• ulOrderBy
• ulViewType
• ulCustomFieldMask
• ulDomain
• ulShowDeleted
• ulSortOrder
• ulCustomer
• ulQuery
• ulProjection
• ulPageToken
• ulMaxResults

data UsersList

Retrieve either deleted users or all users in a domain (paginated)

See: usersList smart constructor.

Instances

Eq UsersList

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

Methods

(==) :: UsersList -> UsersList -> Bool

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

Data UsersList

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

Methods

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

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

toConstr :: UsersList -> Constr

dataTypeOf :: UsersList -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> UsersList -> UsersList

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

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

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

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

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

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

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

Show UsersList

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

Methods

showsPrec :: Int -> UsersList -> ShowS

show :: UsersList -> String

showList :: [UsersList] -> ShowS

Generic UsersList

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

Associated Types

type Rep UsersList :: Type -> Type

Methods

from :: UsersList -> Rep UsersList x

to :: Rep UsersList x -> UsersList

GoogleRequest UsersList

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

Associated Types

type Rs UsersList :: Type

type Scopes UsersList :: [Symbol]

Methods

requestClient :: UsersList -> GClient (Rs UsersList)

type Rep UsersList

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

type Rep UsersList = D1 (MetaData "UsersList" "Network.Google.Resource.Directory.Users.List" "gogol-admin-directory-0.5.0-CACG6Jlc7nkAJWZ09aW4bk" False) (C1 (MetaCons "UsersList'" PrefixI True) (((S1 (MetaSel (Just "_ulEvent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UsersListEvent)) :*: (S1 (MetaSel (Just "_ulOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UsersListOrderBy)) :*: S1 (MetaSel (Just "_ulViewType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UsersListViewType))) :*: (S1 (MetaSel (Just "_ulCustomFieldMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ulDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ulShowDeleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_ulSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UsersListSortOrder)) :*: (S1 (MetaSel (Just "_ulCustomer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ulQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_ulProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UsersListProjection) :*: (S1 (MetaSel (Just "_ulPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ulMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))))))))

type Scopes UsersList

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

type Scopes UsersList = "https://www.googleapis.com/auth/admin.directory.user" ': ("https://www.googleapis.com/auth/admin.directory.user.readonly" ': ([] :: [Symbol]))

type Rs UsersList

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

type Rs UsersList = Users

Request Lenses

ulEvent :: Lens' UsersList (Maybe UsersListEvent)

Event on which subscription is intended (if subscribing)

ulOrderBy :: Lens' UsersList (Maybe UsersListOrderBy)

Column to use for sorting results

ulViewType :: Lens' UsersList UsersListViewType

Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.

ulCustomFieldMask :: Lens' UsersList (Maybe Text)

Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.

ulDomain :: Lens' UsersList (Maybe Text)

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

ulShowDeleted :: Lens' UsersList (Maybe Text)

If set to true retrieves the list of deleted users. Default is false

ulSortOrder :: Lens' UsersList (Maybe UsersListSortOrder)

Whether to return results in ascending or descending order.

ulCustomer :: Lens' UsersList (Maybe Text)

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

ulQuery :: Lens' UsersList (Maybe Text)

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

ulProjection :: Lens' UsersList UsersListProjection

What subset of fields to fetch for this user.

ulPageToken :: Lens' UsersList (Maybe Text)

Token to specify next page in the list

ulMaxResults :: Lens' UsersList (Maybe Int32)

Maximum number of results to return. Default is 100. Max allowed is 500