Method: userRoles.list

  • This method retrieves a list of user roles, with options for filtering and paging.

  • The HTTP request uses a GET method with a URL containing a profileId path parameter.

  • Various query parameters are available to filter and sort the results, including ids, subaccountId, accountUserRoleOnly, and searchString.

  • The request body must be empty.

  • The response body contains a list of user roles and a pagination token if more results are available.

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

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
ids[]

string (int64 format)

Select only user roles with the specified IDs.
subaccountId

string (int64 format)

Select only user roles that belong to this subaccount.
accountUserRoleOnly

boolean

Select only account level user roles not associated with any specific subaccount.
maxResults

integer

Maximum number of results to return.
pageToken

string

Value of the

nextPageToken

from the previous result page.
searchString

string

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"

.
sortField

enum (SortField)

Field by which to sort the list.
sortOrder

enum (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 (UserRole)
    }
  ]
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#userRolesListResponse"

.
nextPageToken

string

Pagination token to be used for the next list operation.
userRoles[]

object (UserRole)

User role collection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking