REST Resource: userRoles
Stay organized with collections
Save and categorize content based on your preferences.
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 |
|
Deletes an existing user role. |
|
Gets one user role by ID. |
|
Inserts a new user role. |
|
Retrieves a list of user roles, possibly filtered. |
|
Updates an existing user role. |
|
Updates an existing user role. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThe UserRole resource manages user access within Display & Video 360 by defining roles and their associated permissions.\u003c/p\u003e\n"],["\u003cp\u003eEach UserRole has properties like ID, name, permissions, and whether it's a default system role.\u003c/p\u003e\n"],["\u003cp\u003eUserRoles can be managed through various methods including creation, deletion, retrieval, and updates.\u003c/p\u003e\n"],["\u003cp\u003eA UserRole is defined by its JSON representation with specific fields like ID, name, account/subaccount IDs, parent role, permissions, default status, and resource kind.\u003c/p\u003e\n"],["\u003cp\u003eYou can use methods such as \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003einsert\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, \u003ccode\u003epatch\u003c/code\u003e, and \u003ccode\u003eupdate\u003c/code\u003e to interact with and manage UserRoles within the system.\u003c/p\u003e\n"]]],[],null,["# REST Resource: userRoles\n\n- [Resource: UserRole](#UserRole)\n - [JSON representation](#UserRole.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: UserRole\n------------------\n\nContains properties of a[user role](https://support.google.com/dcm/answer/6098287), which is used to manage user access.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"name\": string, \"accountId\": string, \"subaccountId\": string, \"parentUserRoleId\": string, \"permissions\": [ { object (/doubleclick-advertisers/rest/v4/userRolePermissions#UserRolePermission) } ], \"defaultUserRole\": boolean, \"kind\": string } ``` |\n\n| Fields ||\n|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of this user role. This is a read-only, auto-generated field. |\n| `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. |\n| `account``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Account ID of this user role. This is a read-only field that can be left blank. |\n| `subaccount``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Subaccount ID of this user role. This is a read-only field that can be left blank. |\n| `parent``User``Role``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of the user role that this user role is based on or copied from. This is a required field. |\n| `permissions[]` | `object (`[UserRolePermission](/doubleclick-advertisers/rest/v4/userRolePermissions#UserRolePermission)`)` userRoles.list of permissions associated with this user role. |\n| `default``User``Role` | `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. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#userRole\"` . |\n\n| Methods ------- ||\n|-----------------------------------------------------------------|----------------------------------------------------|\n| ### [delete](/doubleclick-advertisers/rest/v4/userRoles/delete) | Deletes an existing user role. |\n| ### [get](/doubleclick-advertisers/rest/v4/userRoles/get) | Gets one user role by ID. |\n| ### [insert](/doubleclick-advertisers/rest/v4/userRoles/insert) | Inserts a new user role. |\n| ### [list](/doubleclick-advertisers/rest/v4/userRoles/list) | Retrieves a list of user roles, possibly filtered. |\n| ### [patch](/doubleclick-advertisers/rest/v4/userRoles/patch) | Updates an existing user role. |\n| ### [update](/doubleclick-advertisers/rest/v4/userRoles/update) | Updates an existing user role. |"]]