dfareporting.user Roles.list
GET {{baseUrl}}/userprofiles/:profileId/userRoles?accountUserRoleOnly=<boolean>&ids=<string>&ids=<string>&maxResults=<integer>&pageToken=<string>&searchString=<string>&sortField=<string>&sortOrder=<string>&subaccountId=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Retrieves a list of user roles, possibly filtered. This method supports paging.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
accountUserRoleOnly | string | Select only account level user roles not associated with any specific subaccount. | |
ids | string | Select only user roles with the specified IDs. | |
ids | string | Select only user roles with the specified IDs. | |
maxResults | string | 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, "userrole2015" 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 | string | Field by which to sort the list. | |
sortOrder | string | Order of sorted results. | |
subaccountId | string | Select only user roles that belong to this subaccount. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"kind":"in sit elit irure","nextPageToken":"ut veniam officia nostrud","userRoles":[{"accountId":"reprehenderit occaecat","defaultUserRole":true,"id":"aliqua Excepteur proident commodo ipsum","kind":"tempor Duis dolor cupidatat aliqua","name":"exercitation ut anim sint Lorem","parentUserRoleId":"sunt","permissions":[{"availability":"ACCOUNT_BY_DEFAULT","id":"dolor anim","kind":"tempor aliquip","name":"dolore adipisicing","permissionGroupId":"dolore occaecat nulla ut exercitation"},{"availability":"SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT","id":"consequat ad l","kind":"aute proident dolor","name":"non","permissionGroupId":"nisi in"}],"subaccountId":"est non occaecat"},{"accountId":"do dolor pariatur Duis","defaultUserRole":true,"id":"eu sit","kind":"sint dolore voluptate","name":"incididunt amet","parentUserRoleId":"elit in incididunt","permissions":[{"availability":"ACCOUNT_BY_DEFAULT","id":"fugiat qui incididunt","kind":"magna","name":"minim magna mollit","permissionGroupId":"sunt anim"},{"availability":"SUBACCOUNT_AND_ACCOUNT_ALWAYS","id":"qui et reprehenderit","kind":"do","name":"tempor nulla","permissionGroupId":"labore aliquip"}],"subaccountId":"ipsum sunt aliqua voluptate"}]}