Skip to content

Office365groupsClient

Attributes

OnGroupMemberAddedOrRemovedResponse module-attribute 

OnGroupMemberAddedOrRemovedResponse = List[Dict[str, Any]]

OnNewEventResponse module-attribute 

OnNewEventResponse = List[Dict[str, Any]]

TRIGGER_OPERATIONS module-attribute 

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnGroupMembershipChange': {'operation_id': 'OnGroupMembershipChange', 'path': '/{connectionId}/trigger/v1.0/groups/delta', 'method': 'get', 'required_parameters': ['groupId'], 'callback_payload_type': 'OnGroupMemberAddedOrRemovedResponse'}, 'OnNewEvent': {'operation_id': 'OnNewEvent', 'path': '/{connectionId}/trigger/v1.0/groups/{groupId}/events', 'method': 'get', 'required_parameters': ['groupId'], 'callback_payload_type': 'OnNewEventResponse'}}

Classes

ListGroupMembersResponse dataclass 

ListGroupMembersResponse(context: Optional[str] = None, next_link: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List group members

Attributes

context class-attribute instance-attribute 
context: Optional[str] = field(default=None, metadata={'wire_name': '@odata.context'})

The OData context.

next_link: Optional[str] = field(default=None, metadata={'wire_name': '@odata.nextLink'})

Only used in Power Apps Canvas to genereate the $skipToken for pagination. Power Automate and Logic Apps must use the pagination setting.

value class-attribute instance-attribute 
value: Optional[List[Dict[str, Any]]] = None

value

ListGroupsResponse dataclass 

ListGroupsResponse(context: Optional[str] = None, next_link: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List groups

Attributes

context class-attribute instance-attribute 
context: Optional[str] = field(default=None, metadata={'wire_name': '@odata.context'})

The OData context.

next_link: Optional[str] = field(default=None, metadata={'wire_name': '@odata.nextLink'})

Only used in Power Apps Canvas to genereate the $skipToken for pagination. Power Automate and Logic Apps must use the pagination setting.

value class-attribute instance-attribute 
value: Optional[List[Dict[str, Any]]] = None

value

CreateCalendarEventResponse dataclass 

CreateCalendarEventResponse(id: Optional[str] = None, reminder_minutes_before_start: Optional[int] = None, is_reminder_on: Optional[bool] = None, subject: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, response_requested: Optional[bool] = None, show_as: Optional[str] = None, body: Optional[Dict[str, Any]] = None, start: Optional[Dict[str, Any]] = None, end: Optional[Dict[str, Any]] = None, location: Optional[Dict[str, Any]] = None)

Response for Update a group event

Attributes

id class-attribute instance-attribute 
id: Optional[str] = None

Unique id of the event.

reminder_minutes_before_start class-attribute instance-attribute 
reminder_minutes_before_start: Optional[int] = field(default=None, metadata={'wire_name': 'reminderMinutesBeforeStart'})

Time in minutes before event starts to remind.

is_reminder_on class-attribute instance-attribute 
is_reminder_on: Optional[bool] = field(default=None, metadata={'wire_name': 'isReminderOn'})

Set to true if the event has a reminder.

subject class-attribute instance-attribute 
subject: Optional[str] = None

Title of the event.

importance class-attribute instance-attribute 
importance: Optional[str] = None

The importance of the event: Low, Normal, or High.

is_all_day class-attribute instance-attribute 
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'isAllDay'})

True if the event is an all day event.

response_requested class-attribute instance-attribute 
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'responseRequested'})

True if a response was requested for the event.

show_as class-attribute instance-attribute 
show_as: Optional[str] = field(default=None, metadata={'wire_name': 'showAs'})

Status to show during the event.

body class-attribute instance-attribute 
body: Optional[Dict[str, Any]] = None

body

start class-attribute instance-attribute 
start: Optional[Dict[str, Any]] = None

start

end class-attribute instance-attribute 
end: Optional[Dict[str, Any]] = None

end

location class-attribute instance-attribute 
location: Optional[Dict[str, Any]] = None

location

ObjectWithoutType dataclass 

ObjectWithoutType(additional_properties: Dict[str, Any] = dict())

Response for Send an HTTP request

Attributes

additional_properties class-attribute instance-attribute 
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ListOwnedGroupsResponse dataclass 

ListOwnedGroupsResponse(context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List groups that I own and belong to

Attributes

context class-attribute instance-attribute 
context: Optional[str] = field(default=None, metadata={'wire_name': '@odata.context'})

The OData context.

value class-attribute instance-attribute 
value: Optional[List[Dict[str, Any]]] = None

value

SensitivityLabelMetadata dataclass 

SensitivityLabelMetadata(sensitivity_label_id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, tooltip: Optional[str] = None, priority: Optional[int] = None, color: Optional[str] = None, is_encrypted: Optional[bool] = None, is_enabled: Optional[bool] = None, is_parent: Optional[bool] = None, parent_sensitivity_label_id: Optional[str] = None)

Definition: SensitivityLabelMetadata

Attributes

sensitivity_label_id class-attribute instance-attribute 
sensitivity_label_id: Optional[str] = field(default=None, metadata={'wire_name': 'sensitivityLabelId'})

SensitivityLabel Id.

name class-attribute instance-attribute 
name: Optional[str] = None

SensitivityLabel name.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

SensitivityLabel displayName info

tooltip class-attribute instance-attribute 
tooltip: Optional[str] = None

SensitivityLabel details on tooltip.

priority class-attribute instance-attribute 
priority: Optional[int] = None

SensitivityLabel priority.

color class-attribute instance-attribute 
color: Optional[str] = None

SensitivityLabel color.

is_encrypted class-attribute instance-attribute 
is_encrypted: Optional[bool] = field(default=None, metadata={'wire_name': 'isEncrypted'})

is SensitivityLabel Encrypted.

is_enabled class-attribute instance-attribute 
is_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'isEnabled'})

Whether SensitivityLabel is Enabled.

is_parent class-attribute instance-attribute 
is_parent: Optional[bool] = field(default=None, metadata={'wire_name': 'isParent'})

Whether SensitivityLabel is Parent.

parent_sensitivity_label_id class-attribute instance-attribute 
parent_sensitivity_label_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentSensitivityLabelId'})

Parent SensitivityLabel Id.

UpdateCalendarEventRequest dataclass 

UpdateCalendarEventRequest(subject: Optional[str] = None, start: Optional[Dict[str, Any]] = None, end: Optional[Dict[str, Any]] = None, body: Optional[Dict[str, Any]] = None, location: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, is_reminder_on: Optional[bool] = None, reminder_minutes_before_start: Optional[int] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None)

Definition: UpdateCalendarEvent_Request

Attributes

subject class-attribute instance-attribute 
subject: Optional[str] = None

Title of the event.

importance class-attribute instance-attribute 
importance: Optional[str] = None

The importance of the event: Low, Normal, or High.

is_all_day class-attribute instance-attribute 
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'isAllDay'})

Set to true if the event lasts all day.

is_reminder_on class-attribute instance-attribute 
is_reminder_on: Optional[bool] = field(default=None, metadata={'wire_name': 'isReminderOn'})

Set to true if the event has a reminder.

reminder_minutes_before_start class-attribute instance-attribute 
reminder_minutes_before_start: Optional[int] = field(default=None, metadata={'wire_name': 'reminderMinutesBeforeStart'})

Time in minutes before event start to remind.

show_as class-attribute instance-attribute 
show_as: Optional[str] = field(default=None, metadata={'wire_name': 'showAs'})

Status to show during the event.

response_requested class-attribute instance-attribute 
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'responseRequested'})

Set to true if the sender would like a response when the event is accepted or declined.

UpdateCalendarEventHTMLRequest dataclass 

UpdateCalendarEventHTMLRequest(subject: Optional[str] = None, start: Optional[Dict[str, Any]] = None, end: Optional[Dict[str, Any]] = None, body: Optional[Dict[str, Any]] = None, location: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, is_reminder_on: Optional[bool] = None, reminder_minutes_before_start: Optional[int] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None)

Definition: UpdateCalendarEvent_HTMLRequest

Attributes

subject class-attribute instance-attribute 
subject: Optional[str] = None

Title of the event.

importance class-attribute instance-attribute 
importance: Optional[str] = None

The importance of the event: Low, Normal, or High.

is_all_day class-attribute instance-attribute 
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'isAllDay'})

Set to true if the event lasts all day.

is_reminder_on class-attribute instance-attribute 
is_reminder_on: Optional[bool] = field(default=None, metadata={'wire_name': 'isReminderOn'})

Set to true if the event has a reminder.

reminder_minutes_before_start class-attribute instance-attribute 
reminder_minutes_before_start: Optional[int] = field(default=None, metadata={'wire_name': 'reminderMinutesBeforeStart'})

Time in minutes before event start to remind.

show_as class-attribute instance-attribute 
show_as: Optional[str] = field(default=None, metadata={'wire_name': 'showAs'})

Status to show during the event.

response_requested class-attribute instance-attribute 
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'responseRequested'})

Set to true if the sender would like a response when the event is accepted or declined.

Office365groupsClient 

Office365groupsClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for office365groups connector.

Initialize a Office365groupsClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

 required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

list_group_members_async async 
list_group_members_async(group_id: str, top: Optional[int] = None) -> dict[str, Any] | None

List group members

This operation returns a list of all members in the given group and their details such as name, title, email, etc. You can query up to 1000 items using Top parameter. In case you need to retrieve more than 1000 values please turn on Settings->Pagination feature and provide Threshold limit.

add_member_to_group_async async 
add_member_to_group_async(group_id: str, user_upn: str) -> None

Add member to group

This operation is used to add a member to an O365 group, using a UPN.

list_groups_async async 
list_groups_async(extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, filter: Optional[str] = None, top: Optional[int] = None, skiptoken: Optional[str] = None) -> dict[str, Any] | None

List groups

This operation returns a list of all groups in the organization.

update_calendar_event_async async 
update_calendar_event_async(input: UpdateCalendarEventHTMLRequest, group_id: str, event: str) -> dict[str, Any] | None

Update a group event

This operation is used to update a new event in a group calendar.

remove_member_from_group_async async 
remove_member_from_group_async(group_id: str, user_upn: str) -> None

Remove member from group

This operation is used to remove a member from an O365 group, using a UPN.

list_deleted_groups_async async 
list_deleted_groups_async() -> dict[str, Any] | None

List deleted groups

Lists deleted groups that can be restored.

restore_deleted_group_async async 
restore_deleted_group_async(group_id: str) -> None

Restore a deleted group

Restore a recently deleted group

list_deleted_groups_by_owner_async async 
list_deleted_groups_by_owner_async() -> dict[str, Any] | None

List deleted groups by owner

List deleted groups that can be restored by owner

calendar_delete_item_async async 
calendar_delete_item_async(group_id: str, event: str) -> None

Delete event

This operation deletes an event in a calendar.

create_calendar_event_async async 
create_calendar_event_async(input: UpdateCalendarEventHTMLRequest, group_id: str) -> dict[str, Any] | None

Create a group event

This operation is used to create a new event in a group calendar.

http_request_async async 
http_request_async(input: bytes) -> dict[str, Any] | None

Send an HTTP request

Construct a Microsoft Graph REST API request to invoke. There is one segment that is supported: /groups. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api.

list_owned_groups_async async 
list_owned_groups_async(extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> dict[str, Any] | None

List groups that I own and belong to

This operation returns a list of all groups that you own and belong to.