UserRole

import type { UserRole } from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";

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

interface UserRole {

accountId?: bigint;

defaultUserRole?: boolean;

id?: bigint;

kind?: string;

name?: string;

parentUserRoleId?: bigint;

permissions?: UserRolePermission[];

subaccountId?: bigint;

}

§Properties

accountId?: bigint

[src]

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

defaultUserRole?: boolean

[src]

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?: bigint

[src]

ID of this user role. This is a read-only, auto-generated field.

kind?: string

[src]

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".

name?: string

[src]

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?: bigint

[src]

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

permissions?: UserRolePermission[]

[src]

List of permissions associated with this user role.

subaccountId?: bigint

[src]

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