Defines roles and permissions assigned to a user.
Properties
| Name | Data Type | Description |
|---|---|---|
Client |
ClientID | Specifies the account ownership and context of an object. |
CorrelationID |
String | Identifies correlation of objects across several requests. |
CreatedDate |
DateTime | The date and time when the object was created. |
CustomerKey |
String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
Description |
String | Describes and provides information regarding the object. |
ForceInheritance |
Boolean | Indicates if the application forces inheritance of permission from role. |
ID |
Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
IsPrivate |
Boolean | Indicates whether role is defined by Marketing Cloud Engagement or a client. |
IsSystemDefined |
Boolean | Indicates whether role is defined by the application. |
ModifiedDate |
DateTime | The date and time when the object was last modified. |
Name |
String | Name of the object or property. |
ObjectID |
String | System-controlled, read-only text string identifier for object. |
ObjectState |
String | Not used. |
Owner |
Owner | Describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey |
String | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties |
Array of APIProperty objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
Permissions |
Array of Permission objects | Specifies an array of permissions. |
PermissionSets |
Array of PermissionSet objects | Indicates permission sets applied to a Role or PermissionSet object. |