REST Resource: userRolePermissions

  • The UserRolePermission resource outlines properties associated with user roles and their permissions within the system.

  • Each UserRolePermission is identified by a unique ID and name, belonging to a specific permission group, and has varying levels of availability.

  • Availability levels for UserRolePermissions range from not available by default to always available for accounts and/or subaccounts.

  • The API provides methods to retrieve individual user role permissions by ID and list all available permissions based on optional filters.

Resource: UserRolePermission

Contains properties of a user role permission.

JSON representation 
{
  "id": string,
  "name": string,
  "permissionGroupId": string,
  "availability": enum (UserRolePermissionAvailability),
  "kind": string
}
Fields
id

string (int64 format)

ID of this user role permission.
name

string

Name of this user role permission.
permissionGroupId

string (int64 format)

ID of the permission group that this user role permission belongs to.
availability

enum (UserRolePermissionAvailability)

Levels of availability for a user role permission.
kind

string

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

"dfareporting#userRolePermission"

.

Methods

get

 Gets one user role permission by ID.

list

 Gets a list of user role permissions, possibly filtered.