REST Resource: userRolePermissions
Stay organized with collections
Save and categorize content based on your preferences.
Resource: UserRolePermission
| 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"
.
|
UserRolePermissionAvailability
Levels of availability for a user role permission.
| Enums |
NOT_AVAILABLE_BY_DEFAULT |
Not available by default. |
ACCOUNT_BY_DEFAULT |
Available by default to accounts only. |
SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT |
Available by default to both accounts and subaccounts. |
ACCOUNT_ALWAYS |
Always available to accounts. |
SUBACCOUNT_AND_ACCOUNT_ALWAYS |
Always available to both accounts and subaccounts. |
USER_PROFILE_ONLY |
Available for user profile permissions only. |
Methods |
|
|
Gets one user role permission by ID. |
|
|
Gets a list of user role permissions, possibly filtered. |
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 UserRolePermission resource outlines properties associated with user roles and their permissions within the system.\u003c/p\u003e\n"],["\u003cp\u003eEach UserRolePermission is identified by a unique ID and name, belonging to a specific permission group, and has varying levels of availability.\u003c/p\u003e\n"],["\u003cp\u003eAvailability levels for UserRolePermissions range from not available by default to always available for accounts and/or subaccounts.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides methods to retrieve individual user role permissions by ID and list all available permissions based on optional filters.\u003c/p\u003e\n"]]],[],null,["# REST Resource: userRolePermissions\n\n- [Resource: UserRolePermission](#UserRolePermission)\n - [JSON representation](#UserRolePermission.SCHEMA_REPRESENTATION)\n - [UserRolePermissionAvailability](#UserRolePermission.UserRolePermissionAvailability)\n- [Methods](#METHODS_SUMMARY)\n\nResource: UserRolePermission\n----------------------------\n\nContains properties of a [user role permission](https://support.google.com/dcm/answer/6098250).\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"name\": string, \"permissionGroupId\": string, \"availability\": enum (/doubleclick-advertisers/rest/v4/userRolePermissions#UserRolePermission.UserRolePermissionAvailability), \"kind\": string } ``` |\n\n| Fields ||\n|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of this user role permission. |\n| `name` | `string` Name of this user role permission. |\n| `permission``Group``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of the permission group that this user role permission belongs to. |\n| `availability` | `enum (`[UserRolePermissionAvailability](/doubleclick-advertisers/rest/v4/userRolePermissions#UserRolePermission.UserRolePermissionAvailability)`)` Levels of availability for a user role permission. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#userRolePermission\"` . |\n\n### UserRolePermissionAvailability\n\nLevels of availability for a user role permission.\n\n| Enums ||\n|-------------------------------------|--------------------------------------------------------|\n| `NOT_AVAILABLE_BY_DEFAULT` | Not available by default. |\n| `ACCOUNT_BY_DEFAULT` | Available by default to accounts only. |\n| `SUBACCOUNT_AND_ACCOUNT_BY_DEFAULT` | Available by default to both accounts and subaccounts. |\n| `ACCOUNT_ALWAYS` | Always available to accounts. |\n| `SUBACCOUNT_AND_ACCOUNT_ALWAYS` | Always available to both accounts and subaccounts. |\n| `USER_PROFILE_ONLY` | Available for user profile permissions only. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------|----------------------------------------------------------|\n| ### [get](/doubleclick-advertisers/rest/v4/userRolePermissions/get) | Gets one user role permission by ID. |\n| ### [list](/doubleclick-advertisers/rest/v4/userRolePermissions/list) | Gets a list of user role permissions, possibly filtered. |"]]
