Get shiftsRoleDefinition

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.

Read the properties and relationships of a shiftsRoleDefinition object.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Schedule.Read.All	SchedulePermissions.ReadWrite.All, Schedule.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Schedule.Read.All	SchedulePermissions.ReadWrite.All, Schedule.ReadWrite.All

HTTP request

GET /team/{teamId}/schedule/shiftsRoleDefinitions/{roleId}

Path parameters

Parameter	Type	Description
teamId	string	Team ID to set the role definitions.
roleId	string	The affected role. Current supported values are teamowner and scheduleowner.

Supported values for roleId

Name	Description
scheduleOwner	Sets definitions for a schedule owner.
teamOwner	Sets definitions for a team owner.

Optional query parameters

This method doesn't support OData query parameters to customize the response.

Request headers

Name	Description
Authorization	Bearer {token}. Required.
MS-APP-ACTS-AS	A user ID (GUID). Required only if the authorization token is an application token; otherwise, optional.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a shiftsRoleDefinition object in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/team/10c2c1cc-6384-48f6-aeba-ef7486344550/schedule/shiftsRoleDefinitions/scheduleowner

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "scheduleowner",
  "displayName": "Schedule owner",
  "description": "A person who creates and manages schedules for their teams in Shifts.",
  "shiftsRolePermissions": [
    {
      "allowedResourceActions": [
        "CanModifySchedulingGroups",
        "CanModifyTimeOffReasons"
      ]
    }
  ]
}