Copyright | (c) 2015 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 |
Retrieves a list of account user profiles, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.accountUserProfiles.list
.
- type AccountUserProFilesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("accountUserProfiles" :> (QueryParam "userRoleId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AccountUserProFilesListSortOrder :> (QueryParam "active" Bool :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AccountUserProFilesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` AccountUserProFilesListResponse))))))))))))))
- accountUserProFilesList :: Int64 -> AccountUserProFilesList
- data AccountUserProFilesList
- aupflUserRoleId :: Lens' AccountUserProFilesList (Maybe Int64)
- aupflSearchString :: Lens' AccountUserProFilesList (Maybe Text)
- aupflIds :: Lens' AccountUserProFilesList [Int64]
- aupflProFileId :: Lens' AccountUserProFilesList Int64
- aupflSortOrder :: Lens' AccountUserProFilesList (Maybe AccountUserProFilesListSortOrder)
- aupflActive :: Lens' AccountUserProFilesList (Maybe Bool)
- aupflPageToken :: Lens' AccountUserProFilesList (Maybe Text)
- aupflSortField :: Lens' AccountUserProFilesList (Maybe AccountUserProFilesListSortField)
- aupflSubAccountId :: Lens' AccountUserProFilesList (Maybe Int64)
- aupflMaxResults :: Lens' AccountUserProFilesList (Maybe Int32)
REST Resource
type AccountUserProFilesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("accountUserProfiles" :> (QueryParam "userRoleId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AccountUserProFilesListSortOrder :> (QueryParam "active" Bool :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AccountUserProFilesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` AccountUserProFilesListResponse)))))))))))))) Source
A resource alias for dfareporting.accountUserProfiles.list
method which the
AccountUserProFilesList
request conforms to.
Creating a Request
accountUserProFilesList Source
Creates a value of AccountUserProFilesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AccountUserProFilesList Source
Retrieves a list of account user profiles, possibly filtered.
See: accountUserProFilesList
smart constructor.
Request Lenses
aupflUserRoleId :: Lens' AccountUserProFilesList (Maybe Int64) Source
Select only user profiles with the specified user role ID.
aupflSearchString :: Lens' AccountUserProFilesList (Maybe Text) Source
Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
aupflIds :: Lens' AccountUserProFilesList [Int64] Source
Select only user profiles with these IDs.
aupflProFileId :: Lens' AccountUserProFilesList Int64 Source
User profile ID associated with this request.
aupflSortOrder :: Lens' AccountUserProFilesList (Maybe AccountUserProFilesListSortOrder) Source
Order of sorted results, default is ASCENDING.
aupflActive :: Lens' AccountUserProFilesList (Maybe Bool) Source
Select only active user profiles.
aupflPageToken :: Lens' AccountUserProFilesList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
aupflSortField :: Lens' AccountUserProFilesList (Maybe AccountUserProFilesListSortField) Source
Field by which to sort the list.
aupflSubAccountId :: Lens' AccountUserProFilesList (Maybe Int64) Source
Select only user profiles with the specified subaccount ID.
aupflMaxResults :: Lens' AccountUserProFilesList (Maybe Int32) Source
Maximum number of results to return.