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