REST Resource: userRoles

  • A UserRole resource contains properties used to manage user access.

  • The JSON representation of a UserRole includes fields such as id, name, accountId, subaccountId, parentUserRoleId, permissions, defaultUserRole, and kind.

  • The available methods for UserRole resources include delete, get, insert, list, patch, and update.

Resource: UserRole

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

JSON representation 
{
  "id": string,
  "name": string,
  "accountId": string,
  "subaccountId": string,
  "parentUserRoleId": string,
  "permissions": [
    {
      object (UserRolePermission)
    }
  ],
  "defaultUserRole": boolean,
  "kind": string
}
Fields
id

string (int64 format)

ID of this user role. This is a read-only, auto-generated field.
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.
accountId

string (int64 format)

Account ID of this user role. This is a read-only field that can be left blank.
subaccountId

string (int64 format)

Subaccount ID of this user role. This is a read-only field that can be left blank.
parentUserRoleId

string (int64 format)

ID of the user role that this user role is based on or copied from. This is a required field.
permissions[]

object (UserRolePermission)

userRoles.list of permissions associated with this user role.
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.
kind

string

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

"dfareporting#userRole"

.

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.

patch

 Updates an existing user role.

update

 Updates an existing user role.