- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Retrieves a list of user roles, possibly filtered. This method supports paging .
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/userRoles
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profileId
|
User profile ID associated with this request. |
Query parameters
Parameters | |
---|---|
ids[]
|
Select only user roles with the specified IDs. |
subaccountId
|
Select only user roles that belong to this subaccount. |
accountUserRoleOnly
|
Select only account level user roles not associated with any specific subaccount. |
maxResults
|
Maximum number of results to return. |
pageToken
|
Value of the from the previous result page. |
searchString
|
Allows searching for objects by name or ID. Wildcards ( ) are allowed. For example, will return objects with names like , , or simply . Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of will match objects with name , , or simply . |
sortField
|
Field by which to sort the list. |
sortOrder
|
Order of sorted results. |
Request body
The request body must be empty.
Response body
User Role userRoles.list Response
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"kind"
:
string
,
"nextPageToken"
:
string
,
"userRoles"
:
[
{
object (
|
Fields | |
---|---|
kind
|
Identifies what kind of resource this is. Value: the fixed string . |
nextPageToken
|
Pagination token to be used for the next list operation. |
userRoles[]
|
User role collection. |
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/dfatrafficking