Role

Defines roles and permissions assigned to a user.

NameData TypeDescription
ClientClientIDSpecifies the account ownership and context of an object.
CorrelationIDStringIdentifies correlation of objects across several requests.
CreatedDateDateTimeThe date and time when the object was created.
CustomerKeyStringUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object.
DescriptionStringDescribes and provides information regarding the object.
ForceInheritanceBooleanIndicates if the application forces inheritance of permission from role.
IDIntRead-only identifier for an object. Some objects use the ObjectID property as a unique ID.
IsPrivateBooleanIndicates whether role is defined by Marketing Cloud Engagement or a client.
IsSystemDefinedBooleanIndicates whether role is defined by the application.
ModifiedDateDateTimeThe date and time when the object was last modified.
NameStringName of the object or property.
ObjectIDStringSystem-controlled, read-only text string identifier for object.
ObjectStateStringNot used.
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyStringUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesArray of APIProperty objectsA collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
PermissionsArray of Permission objectsSpecifies an array of permissions.
PermissionSetsArray of PermissionSet objectsIndicates permission sets applied to a Role or PermissionSet object.