Microsoft: Invoke function allowed Calendar Sharing Roles — me Calendar calendars Allowed Calendar Sharing Roles

← Me calendar operations · Get started

Operation microsoft.me_calendars_calendar_allowedcalendarsharingroles

Provider route: GET /me/calendars/{calendar-id}/allowedCalendarSharingRoles(User='{User}'). Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/microsoft with npm, or alter-sdk-microsoft with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MicrosoftIntegration } from "@alter-ai/microsoft";

async function execute(input: Parameters<MicrosoftIntegration["meCalendar"]["calendarsAllowedCalendarSharingRoles"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new MicrosoftIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.meCalendar.calendarsAllowedCalendarSharingRoles(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_microsoft import MicrosoftIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = MicrosoftIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.me_calendar.calendars_allowed_calendar_sharing_roles(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.calendar-id	string	Required within parent
path.User	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.$top	integer	Optional	Minimum: 0
query.$skip	integer	Optional	Minimum: 0
query.$search	string	Optional
query.$filter	string	Optional
query.$count	boolean	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
$ (allOf 1)	Model	All variants apply	Expand List rules — response body — @odata count, @odata next Link
$ (allOf 2)	object	All variants apply
$ (allOf 2).value	array	Optional
$ (allOf 2).value[]	string	Each item	Known values: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom

Referenced models: List rules — response body — @odata count, @odata next Link

Schemas

List rules — response body — @odata count, @odata next Link

Field	Type	Presence	Description and constraints
$	object	Root
@odata.count	JSON	Optional
@odata.count (anyOf 1)	JSON	Alternative
@odata.count (anyOf 1) (anyOf 1)	integer	Alternative	Format: int64
@odata.count (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
@odata.count (anyOf 2)	null	Alternative
@odata.nextLink	JSON	Optional
@odata.nextLink (anyOf 1)	string	Alternative
@odata.nextLink (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: microsoft.me_calendars_calendar_allowedcalendarsharingroles. Catalog operation: me_calendars_calendar_allowedcalendarsharingroles. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source