Connectors Reference

GroupMgr

A powerful set of tools, for both IT managers and users, to efficiently create, manage, browse and analyse all groups in your Microsoft 365 environment.

 

Status: Preview

Tier: Premium

Version: 2.4

 

Actions:

Name

Summary

GroupMgrGroupTriggerUnsubscribe (string id)

Unsubscribe when a group is created

GroupMgrGroupApproval (GroupMgrGroupApprovalParameterBody body)

Approve or Reject a requested group

GroupMgrCreateGroup (GroupMgrCreateGroupParameterBody body)

Create a group

GroupMgrUpdateGroup (GroupMgrUpdateGroupParameterBody body)

Update a group

GroupMgrDeleteGroup (GroupMgrDeleteGroupParameterBody body)

Delete a group

GroupMgrArchiveGroup (GroupMgrArchiveGroupParameterBody body)

Archive or Unarchive a group

GetGroupTypes ()

Group types

 

Triggers:

Name

Summary

GroupMgrGroupRequested (GroupMgrGroupRequestedParameterBody body)

When a new group is requested. (Approval flow)

GroupMgrGroupCreated (GroupMgrGroupCreatedParameterBody body)

When a new group is created

GroupMgrGroupUpdated (GroupMgrGroupUpdatedParameterBody body)

When a group is updated

GroupMgrGroupDeleted (GroupMgrGroupDeletedParameterBody body)

When a group is removed

 

Objects:

Name

Summary

GroupExtended

 

GroupMgrArchiveGroupParameterBody

 

GroupMgrArchiveGroupResponse

 

GroupMgrCreateGroupParameterBody

 

GroupMgrDeleteGroupParameterBody

 

GroupMgrDeleteGroupResponse

 

GroupMgrGroupApprovalParameterBody

 

GroupMgrGroupCreatedParameterBody

 

GroupMgrGroupCreatedResponse

 

GroupMgrGroupDeletedParameterBody

 

GroupMgrGroupDeletedResponse

 

GroupMgrGroupRequestedParameterBody

 

GroupMgrGroupRequestedResponse

 

GroupMgrGroupTriggerUnsubscribeResponse

 

GroupMgrGroupUpdatedParameterBody

 

GroupMgrGroupUpdatedResponse

 

GroupMgrUpdateGroupParameterBody

 

GroupTypes

 

 

Actions:

GroupMgrGroupTriggerUnsubscribe

Summary: Unsubscribe when a group is created

Description: This will unsubscribe the trigger for when a new group is created within GroupMgr.

 

Syntax:

GroupMgr.GroupMgrGroupTriggerUnsubscribe (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

 

The webhook Id.

True

 

Returns:

          Type:GroupMgrGroupTriggerUnsubscribeResponse

 

GroupMgrGroupApproval

Summary: Approve or Reject a requested group

Description: Will send an approval back to GroupMgr for the requested group.

 

Syntax:

GroupMgr.GroupMgrGroupApproval (GroupMgrGroupApprovalParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GroupMgrGroupApprovalParameterBody

 

 

True

 

Returns:

          Type:GroupExtended

 

GroupMgrCreateGroup

Summary: Create a group

Description: Create a new group.

 

Syntax:

GroupMgr.GroupMgrCreateGroup (GroupMgrCreateGroupParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GroupMgrCreateGroupParameterBody

 

 

True

 

Returns:

          Type:GroupExtended

 

GroupMgrUpdateGroup

Summary: Update a group

Description: Update an existing group.

 

Syntax:

GroupMgr.GroupMgrUpdateGroup (GroupMgrUpdateGroupParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GroupMgrUpdateGroupParameterBody

 

 

True

 

Returns:

          Type:GroupExtended

 

GroupMgrDeleteGroup

Summary: Delete a group

Description: Delete a group.

 

Syntax:

GroupMgr.GroupMgrDeleteGroup (GroupMgrDeleteGroupParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GroupMgrDeleteGroupParameterBody

 

 

True

 

Returns:

          Type:GroupMgrDeleteGroupResponse

 

GroupMgrArchiveGroup

Summary: Archive or Unarchive a group

Description: Archive a group. Make SharePoint and Teams read-only for this group.

 

Syntax:

GroupMgr.GroupMgrArchiveGroup (GroupMgrArchiveGroupParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GroupMgrArchiveGroupParameterBody

 

 

True

 

Returns:

          Type:GroupMgrArchiveGroupResponse

 

GetGroupTypes

Summary: Group types

Description: All available group types.

 

Syntax:

GroupMgr.GetGroupTypes ()

 

Returns:

          Type:array of (GroupTypes)

 

Triggers:

Trigger GroupMgrGroupRequested

Summary: When a new group is requested. (Approval flow)

Description: This will trigger when a new group is requested within GroupMgr (Only groups with this approval flow).

 

Syntax:

GroupMgr.GroupMgrGroupRequested (GroupMgrGroupRequestedParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GroupMgrGroupRequestedParameterBody

 

 

True

 

Returns:

          Type:GroupMgrGroupRequestedResponse

 

Trigger GroupMgrGroupCreated

Summary: When a new group is created

Description: This will trigger when a new group is created.

 

Syntax:

GroupMgr.GroupMgrGroupCreated (GroupMgrGroupCreatedParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GroupMgrGroupCreatedParameterBody

 

 

True

 

Returns:

          Type:GroupMgrGroupCreatedResponse

 

Trigger GroupMgrGroupUpdated

Summary: When a group is updated

Description: This will trigger when a group is updated.

 

Syntax:

GroupMgr.GroupMgrGroupUpdated (GroupMgrGroupUpdatedParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GroupMgrGroupUpdatedParameterBody

 

 

True

 

Returns:

          Type:GroupMgrGroupUpdatedResponse

 

Trigger GroupMgrGroupDeleted

Summary: When a group is removed

Description: This will trigger when a group is removed.

 

Syntax:

GroupMgr.GroupMgrGroupDeleted (GroupMgrGroupDeletedParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GroupMgrGroupDeletedParameterBody

 

 

True

 

Returns:

          Type:GroupMgrGroupDeletedResponse

 


 

GroupExtended

Summary:

Description:

 

          Properties:

Name

Type

Summary

GroupId

string

 

Id of the group in Microsoft 365.

ListItemId

string

 

GroupMgr internal Id.

DisplayName

string

 

Display name of the group.

Email

string

 

Email of the group.

Owners

array of (string)

 

Owner emails.

Members

array of (string)

 

Member emails.

GroupType

string

 

Group type of the group.

IsPublic

boolean

 

Is the group public.  Values: [, ]

Status

string

 

Status of the Group.

Url

string

 

URL of the SharePoint page.

TeamsUrl

string

 

URL of the Team page.

language

string

 

language

CreateTeam

boolean

 

Create a team for the group.  Values: [, ]


 

GroupMgrArchiveGroupParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

ListItemId

string

 

GroupMgr internal Id.

Archive

string

 

Group action.  Values: [true, false]


 

GroupMgrArchiveGroupResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GroupMgrCreateGroupParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

DisplayName

string

 

Display name of the group.

Email

string

 

Email of the group.

Owners

array of (string)

 

Owner emails.

Members

array of (string)

 

Member emails.

GroupType

string

 

Group type of the group.

IsPublic

string

 

Is the group private or public.  Values: [true, false]

CreateTeam

boolean

 

Create a team for the group.  Values: [, ]


 

GroupMgrDeleteGroupParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

ListItemId

string

 

GroupMgr internal Id.


 

GroupMgrDeleteGroupResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GroupMgrGroupApprovalParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

ListItemId

string

 

GroupMgr internal Id.

Approved

string

 

Group action.  Values: [true, false]


 

GroupMgrGroupCreatedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

webhook

string

 

The webhook URL.


 

GroupMgrGroupCreatedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GroupMgrGroupDeletedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

webhook

string

 

The webhook URL.


 

GroupMgrGroupDeletedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GroupMgrGroupRequestedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

Name for this approval flow.

webhook

string

 

The webhook URL.


 

GroupMgrGroupRequestedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GroupMgrGroupTriggerUnsubscribeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GroupMgrGroupUpdatedParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

webhook

string

 

The webhook URL


 

GroupMgrGroupUpdatedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GroupMgrUpdateGroupParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

GroupId

string

 

The ID of the group you want to update.

DisplayName

string

 

Display name of the group.

Owners

array of (string)

 

Owner emails.

Members

array of (string)

 

Member emails.

GroupType

string

 

Group type of the group.

IsPublic

string

 

Is the group public.  Values: [, true, false]

CreateTeam

boolean

 

Create a team for the group.  Values: [, ]


 

GroupTypes

Summary:

Description:

 

          Properties:

Name

Type

Summary

ListItemId

string

 

The interal ID for the group type.

Title

string

 

The group type title.

Hidden

boolean

 

If the group type is hidden.  Values: [, ]

IsPublic

boolean

 

If the group type is public.  Values: [, ]

Prefix

string

 

The prefix for the group type.

Description

string

 

The description for the group type.

FlowId

string

 

The flow ID for the group type.

PrivacyLocked

boolean

 

If the group type has a privacy lock.  Values: [, ]