GoogleApi.DFAReporting.V4.Model.UserRole (google_api_dfa_reporting v0.31.0)

View Source

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

Attributes

  • accountId (type: String.t, default: nil) - Account ID of this user role. This is a read-only field that can be left blank.
  • defaultUserRole (type: boolean(), default: nil) - 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 (type: String.t, default: nil) - ID of this user role. This is a read-only, auto-generated field.
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
  • name (type: String.t, default: nil) - 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 (type: String.t, default: nil) - ID of the user role that this user role is based on or copied from. This is a required field.
  • permissions (type: list(GoogleApi.DFAReporting.V4.Model.UserRolePermission.t), default: nil) - List of permissions associated with this user role.
  • subaccountId (type: String.t, default: nil) - Subaccount ID of this user role. This is a read-only field that can be left blank.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.DFAReporting.V4.Model.UserRole{
  accountId: String.t() | nil,
  defaultUserRole: boolean() | nil,
  id: String.t() | nil,
  kind: String.t() | nil,
  name: String.t() | nil,
  parentUserRoleId: String.t() | nil,
  permissions: [GoogleApi.DFAReporting.V4.Model.UserRolePermission.t()] | nil,
  subaccountId: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.