Skip to content

calendar-list-calendarpermissions.md

Latest commit

 

History

History
138 lines (109 loc) · 4.29 KB

calendar-list-calendarpermissions.md

File metadata and controls

138 lines (109 loc) · 4.29 KB
title List calendarPermissions
description Get a collection of calendarPermission resources that describe the identity and roles of users with whom the specified calendar has been shared or delegated.
ms.localizationpriority medium
author iamgirishck
ms.subservice outlook
doc_type apiPageType
ms.date 04/05/2024

List calendarPermissions

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a collection of calendarPermission resources that describe the identity and roles of users with whom the specified calendar has been shared or delegated. Here, the calendar can be a user calendar or group calendar.

[!INCLUDE national-cloud-support]

Permissions

Depending on the type of calendar that the event is in and the permission type (delegated or application) requested, one of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Calendar Delegated (work or school account) Delegated (personal Microsoft account) Application
user calendar Calendars.ReadBasic, Calendars.Read, Calendars.ReadWrite Calendars.ReadBasic, Calendars.Read, Calendars.ReadWrite Calendars.ReadBasic, Calendars.Read, Calendars.ReadWrite
group calendar Group.Read.All, Group.ReadWrite.All Not supported. Not supported.

HTTP request

List the specified permissions of a user's primary calendar:

GET /users/{id}/calendar/calendarPermissions

List the specified permissions of a group calendar:

GET /groups/{id}/calendar/calendarPermissions

List the specified permissions of the user calendar that contains the identified event:

GET /users/{id}/events/{id}/calendar/calendarPermissions

Optional query parameters

This method supports some of the OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of calendarPermission objects in the response body.

Examples

Request

GET https://graph.microsoft.com/beta/users/{id}/calendar/calendarPermissions

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('458d4c95-124e-49da-ba9d-1dd0387e682e')/calendar/calendarPermissions",
    "value": [
        {
            "id": "RXhjaGFuZ2VQdWJsaXNoZWRVc2VyLmFkbWluQE0zNjVCODc3NzE5Lm9ubWljcm9zb2Z0LmNvbQ==",
            "isRemovable": true,
            "isInsideOrganization": false,
            "role": "read",
            "allowedRoles": [
                "freeBusyRead",
                "limitedRead",
                "read"
            ],
            "emailAddress": {
                "name": "admin@contoso.com",
                "address": "admin@contoso.com"
            }
        },
        {
            "id": "RGVmYXVsdA==",
            "isRemovable": false,
            "isInsideOrganization": true,
            "role": "freeBusyRead",
            "allowedRoles": [
                "none",
                "freeBusyRead",
                "limitedRead",
                "read",
                "write"
            ],
            "emailAddress": {
                "name": "My Organization"
            }
        }
    ]
}