Page Summary
-
The UserRolePermission resource contains properties of a user role permission.
-
The JSON representation shows the structure with fields like id, name, permissionGroupId, availability, and kind.
-
Fields such as
id,name,permissionGroupId,availability, andkinddefine the user role permission. -
Available methods are
getto retrieve a single permission by ID andlistto get a filtered list.
Resource: UserRolePermission
Contains properties of a user role permission .
| JSON representation |
|---|
{
"id"
:
string
,
"name"
:
string
,
"permissionGroupId"
:
string
,
"availability"
:
enum (
|
| Fields | |
|---|---|
id
|
ID of this user role permission. |
name
|
Name of this user role permission. |
permissionGroupId
|
ID of the permission group that this user role permission belongs to. |
availability
|
Levels of availability for a user role permission. |
kind
|
Identifies what kind of resource this is. Value: the fixed string . |
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. |

