| 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 |
Network.Google.Resource.DFAReporting.UserRoles.List
Description
Retrieves a list of user roles, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.userRoles.list.
- type UserRolesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("userRoles" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" UserRolesListSortOrder :> (QueryParam "accountUserRoleOnly" Bool :> (QueryParam "pageToken" Text :> (QueryParam "sortField" UserRolesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` UserRolesListResponse)))))))))))))
- userRolesList :: Int64 -> UserRolesList
- data UserRolesList
- urlSearchString :: Lens' UserRolesList (Maybe Text)
- urlIds :: Lens' UserRolesList [Int64]
- urlProFileId :: Lens' UserRolesList Int64
- urlSortOrder :: Lens' UserRolesList (Maybe UserRolesListSortOrder)
- urlAccountUserRoleOnly :: Lens' UserRolesList (Maybe Bool)
- urlPageToken :: Lens' UserRolesList (Maybe Text)
- urlSortField :: Lens' UserRolesList (Maybe UserRolesListSortField)
- urlSubAccountId :: Lens' UserRolesList (Maybe Int64)
- urlMaxResults :: Lens' UserRolesList (Maybe Int32)
REST Resource
type UserRolesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("userRoles" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" UserRolesListSortOrder :> (QueryParam "accountUserRoleOnly" Bool :> (QueryParam "pageToken" Text :> (QueryParam "sortField" UserRolesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` UserRolesListResponse))))))))))))) Source
A resource alias for dfareporting.userRoles.list method which the
UserRolesList request conforms to.
Creating a Request
Arguments
| :: Int64 | |
| -> UserRolesList |
Creates a value of UserRolesList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UserRolesList Source
Retrieves a list of user roles, possibly filtered.
See: userRolesList smart constructor.
Request Lenses
urlSearchString :: Lens' UserRolesList (Maybe Text) Source
Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 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 "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
urlIds :: Lens' UserRolesList [Int64] Source
Select only user roles with the specified IDs.
urlProFileId :: Lens' UserRolesList Int64 Source
User profile ID associated with this request.
urlSortOrder :: Lens' UserRolesList (Maybe UserRolesListSortOrder) Source
Order of sorted results, default is ASCENDING.
urlAccountUserRoleOnly :: Lens' UserRolesList (Maybe Bool) Source
Select only account level user roles not associated with any specific subaccount.
urlPageToken :: Lens' UserRolesList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
urlSortField :: Lens' UserRolesList (Maybe UserRolesListSortField) Source
Field by which to sort the list.
urlSubAccountId :: Lens' UserRolesList (Maybe Int64) Source
Select only user roles that belong to this subaccount.
urlMaxResults :: Lens' UserRolesList (Maybe Int32) Source
Maximum number of results to return.