UserRoles

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of auser role, which is used to manage user access.

{
  "kind": "dfareporting#userRole",
  "id": long,
  "name": string,
  "accountId": long,
  "subaccountId": long,
  "parentUserRoleId": long,
  "permissions": [
    userRolePermissions Resource
  ],
  "defaultUserRole": boolean
}
Property name Value Description Notes
accountId long Account ID of this user role. This is a read-only field that can be left blank.
defaultUserRole boolean Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
id long ID of this user role. This is a read-only, auto-generated field.
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
name string Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
parentUserRoleId long ID of the user role that this user role is based on or copied from. This is a required field.
permissions[] list List of permissions associated with this user role.
subaccountId long Subaccount ID of this user role. This is a read-only field that can be left blank.

Methods

delete
Deletes an existing user role.
get
Gets one user role by ID.
insert
Inserts a new user role.
list
Retrieves a list of user roles, possibly filtered. This method supports paging.
patch
Updates an existing user role. This method supports patch semantics.
update
Updates an existing user role.