Connectors Reference

Office 365 Groups

Office 365 Groups lets you manage group membership and calendar events in your organization using your Office 365 account. You can perform various actions such as get group roster, add or remove members and create group events.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

ListGroupMembers (string groupId)

List group members

AddMemberToGroup (string groupId, string userUpn)

Add member to group

ListOwnedGroups ()

List my owned groups

CreateCalendarEvent (string groupId, UpdateCalendarEvent_Request body)

Create a group event

RemoveMemberFromGroup (string groupId, string userUpn)

Remove member from group

 

Triggers:

Name

Summary

OnNewEvent (string groupId)

When there is a new event

 

Objects:

Name

Summary

AddMemberToGroupResponse

 

CreateCalendarEvent_Response

 

ListGroupMembers_Response

 

ListOwnedGroups_Response

 

OnNewEventResponseItem

 

RemoveMemberFromGroupResponse

 

UpdateCalendarEvent_Request

 

 

Actions:

ListGroupMembers

Summary: List group members

Description: This operation returns a list of all members in the given group and their details such as name, title, email, etc.

 

Syntax:

Office365Groups.ListGroupMembers (string groupId)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group Id)

Pick a group from the drop down or enter group id.

True

ListOwnedGroups

 

Returns:

          Type:ListGroupMembers_Response

 

AddMemberToGroup

Summary: Add member to group

Description: This operation is used to add a member to an O365 group, using an email address.

 

Syntax:

Office365Groups.AddMemberToGroup (string groupId, string userUpn)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group Id)

Pick a group from the drop down or enter group id.

True

ListOwnedGroups

userUpn

string

(User's Email)

A user's fully qualified email address (ex. user@microsoft.com).

True

 

Returns:

          Type:AddMemberToGroupResponse

 

ListOwnedGroups

Summary: List my owned groups

Description: This operation returns a list of all groups that you own.

 

Syntax:

Office365Groups.ListOwnedGroups ()

 

Returns:

          Type:ListOwnedGroups_Response

 

CreateCalendarEvent

Summary: Create a group event

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

 

Syntax:

Office365Groups.CreateCalendarEvent (string groupId, UpdateCalendarEvent_Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group Id)

Pick a group from the drop down or enter group id.

True

ListOwnedGroups

body

UpdateCalendarEvent_Request

 

 

True

 

Returns:

          Type:CreateCalendarEvent_Response

 

RemoveMemberFromGroup

Summary: Remove member from group

Description: This operation is used to remove a member from an O365 group, using an email address.

 

Syntax:

Office365Groups.RemoveMemberFromGroup (string groupId, string userUpn)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group Id)

Pick a group from the drop down or enter group id.

True

ListOwnedGroups

userUpn

string

(User's Email)

A user's fully qualified email address. (ex. user@microsoft.com).

True

 

Returns:

          Type:RemoveMemberFromGroupResponse

 

Triggers:

Trigger OnNewEvent

Summary: When there is a new event

Description: This operation triggers when a new event is added to a group calendar.

 

Syntax:

Office365Groups.OnNewEvent (string groupId)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupId

string

(Group Id)

Pick a group from the drop down or enter group id.

True

ListOwnedGroups

 

Returns:

          Type:array of (OnNewEventResponseItem)

          Summary: value

          Description: value

 


 

AddMemberToGroupResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CreateCalendarEvent_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Unique id of the event.

reminderMinutesBeforeStart

integer(int32)

Reminder Start Duration

Time in minutes before event starts to remind.

isReminderOn

boolean

Is Reminder On

Set to true if the event has a reminder.

subject

string

Subject

Title of the event.

importance

string

Importance

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

isAllDay

boolean

Is All Day

True if the event is an all day event.

responseRequested

boolean

Response Requested

True if a response was requested for the event.

showAs

string

Show As

Status to show during the event.

body

Body

Body

body

start

Start

Start

start

end

End

End

end

location

Location

Location

location

 

Body

Summary: Body

Description: body

 

          Properties:

Name

Type

Summary

contentType

string

Content Type

Text or Html.

content

string

Content

The content of the body of this event.

 

Start

Summary: Start

Description: start

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

Date Time

Start time of the event (example: '2016-11-01T14:30:00-07:00').

timeZone

string

Time Zone

Time zone of the event, specified as a time zone index value (example: 'Pacific Standard Time').

 

End

Summary: End

Description: end

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

Date Time

End time of the event (example: '2016-11-01T15:30:00-07:00').

timeZone

string

Time Zone

Time zone of the event, specified as a time zone index value (example: 'Pacific Standard Time').

 

Location

Summary: Location

Description: location

 

          Properties:

Name

Type

Summary

displayName

string

Name

The display name for the location of the event.

 


 

ListGroupMembers_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

value

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

User Id

Unique id of the user.

displayName

string

Display Name

User's display name.

givenName

string

Given Name

User's first name.

jobTitle

string

Job Title

User's job title.

mail

string

Mail

User's email address.

mobilePhone

string

Mobile Phone

User's mobile number.

officeLocation

string

Office Location

User's office address.

surname

string

Surname

User's last name.

userPrincipalName

string

User Principal Name

UPN id of the user.

 


 

ListOwnedGroups_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

OData context

The OData context.

value

array of (ValueItem)

 

value

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

classification

string

Classification

O365 group classification.

createdDateTime

string(date-time)

Created Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

deletedDateTime

string

Deleted Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

description

string

Description

More information about the group.

displayName

string

Name

O365 group name.

id

string

Group Id

Unique identifier of the group.

mail

string

Email

Email address of the group.

mailEnabled

boolean

Mail Enabled

True if mail is enabled for the group.

mailNickname

string

Nickname

Group nickname.

onPremisesLastSyncDateTime

string

On-Premises Last Sync Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

onPremisesSecurityIdentifier

string

On-Premises Security Identifier

The on-premises security identifier.

onPremisesSyncEnabled

string

On-Premises Sync Enabled

True if on-premises sync is enabled for the group.

renewedDateTime

string(date-time)

Renewed Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

securityEnabled

boolean

Security Enabled

True if the owner is security enabled.

visibility

string

Visibility

The owner's visibility.

 


 

OnNewEventResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Unique id of the event.

reminderMinutesBeforeStart

integer(int32)

Reminder Start Duration

The number of minutes before the start of the event the reminder will fire.

isReminderOn

boolean

Is Reminder On

Set to true if the event has a reminder.

subject

string

Subject

Title of the event.

importance

string

Importance

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

isAllDay

boolean

Is All Day

Set to true if the event lasts all day.

responseRequested

boolean

Response Requested

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

showAs

string

Show As

Status to show during the event.

body

Body

Body

body

start

Start

Start

start

end

End

End

end

location

Location

Location

location

 

Body

Summary: Body

Description: body

 

          Properties:

Name

Type

Summary

contentType

string

Content Type

Body of the message associated with the event.

content

string

Content

Pick the content type: Text or Html.

 

Start

Summary: Start

Description: start

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

Date Time

Start time of the event (example: '2016-11-01T14:30:00-07:00').

timeZone

string

Time Zone

Time zone of the event, specified as a time zone index value (example: 'Pacific Standard Time').

 

End

Summary: End

Description: end

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

Date Time

End time of the event (example: '2016-11-01T15:30:00-07:00').

timeZone

string

Time Zone

Time zone of the event, specified as a time zone index value (example: 'Pacific Standard Time').

 

Location

Summary: Location

Description: location

 

          Properties:

Name

Type

Summary

displayName

string

Name

The display name for the location of the event.

 


 

RemoveMemberFromGroupResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

UpdateCalendarEvent_Request

Summary:

Description:

 

          Properties:

Name

Type

Summary

subject

string

Subject

Title of the event.

start

Start

 

 

end

End

 

 

body

Body

 

 

location

Location

 

 

importance

string

Importance

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

isAllDay

boolean

Is All Day

Set to true if the event lasts all day.

isReminderOn

boolean

Is Reminder On

Set to true if the event has a reminder.

reminderMinutesBeforeStart

integer(int32)

Reminder Start Duration

Time in minutes before event start to remind.

showAs

string

Show As

Status to show during the event.  Values: [Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown]

responseRequested

boolean

Response Requested

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

 

Start

Summary:

Description:

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

Start Time

Start time of the event (example: '2016-11-01T14:30:00-07:00').

timeZone

string

Time zone

Time zone of the event, specified as a time zone index value (example: 'Pacific Standard Time').

 

End

Summary:

Description:

 

          Properties:

Name

Type

Summary

dateTime

string(date-time)

End Time

End time of the event (example: '2016-11-01T15:30:00-07:00').

timeZone

string

Time zone

Time zone of the event, specified as a time zone index value (example: 'Pacific Standard Time').

 

Body

Summary:

Description:

 

          Properties:

Name

Type

Summary

content

string

Body

Body of the message associated with the event.

contentType

string

Body Content Type

Pick the content type: Text or Html.  Values: [Text, Html]

 

Location

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Location

Location of the event.