Edit

Share via


engagementRole resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a predefined Viva Engage role. Each role includes a unique identifier and display name and can be assigned to one or more users within the platform.

Inherits from entity.

Methods

Method Return type Description
List engagementRole collection Get a list of all the roles that can be assigned in Viva Engage.
List members engagementRoleMember collection Get a list of users with assigned roles in Viva Engage.
List assigned roles engagementRole Get a list of all the roles assigned to a user in Viva Engage.

Properties

Property Type Description
displayName String The name of the role.
id String The unique identifier of the role. Read-only. Inherits from entity

Relationships

Relationship Type Description
members engagementRoleMember collection Users that have this role assigned.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.engagementRole",
  "id": "String (identifier)",
  "displayName": "String"
}