gogol-useraccounts-0.0.1: Google Cloud User Accounts SDK.

Copyright(c) 2015 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.CloudUserAccounts.Users.List

Contents

Description

Retrieves a list of users contained within the specified project.

See: Cloud User Accounts API Reference for clouduseraccounts.users.list.

Synopsis

REST Resource

type UsersListResource = "clouduseraccounts" :> ("beta" :> ("projects" :> (Capture "project" Text :> ("global" :> ("users" :> (QueryParam "orderBy" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` UserList)))))))))) Source

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

Creating a Request

usersList Source

Arguments

:: Text

ulProject

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

data UsersList Source

Retrieves a list of users contained within the specified project.

See: usersList smart constructor.

Request Lenses

ulOrderBy :: Lens' UsersList (Maybe Text) Source

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

ulProject :: Lens' UsersList Text Source

Project ID for this request.

ulFilter :: Lens' UsersList (Maybe Text) Source

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING. The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, filter=name ne example-instance.

ulPageToken :: Lens' UsersList (Maybe Text) Source

Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.

ulMaxResults :: Lens' UsersList Word32 Source

Maximum count of results to be returned.