Connectors Reference
Automate provisioning, management, and lifecycle for Teams, Groups, Communities, and Sites. Connect to AvePoint Cloud Governance to execute additional actions in Microsoft 365 such as creation of new content, add users, and update information in lists.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Delete web hook |
|
|
Get object status |
|
|
Get object types |
|
|
Get office365 action types |
|
|
Flow_UpdateOffice365Setting (string actionType, Flow_UpdateOffice365SettingParameterBody body) |
Update Microsoft 365 settings |
|
Get sharing domain restriction modes |
|
|
Flow_GetRequestById (string serviceType, string serviceId, string requestId) |
Get a request |
|
Submit a request |
|
|
Update a request |
|
|
Flow_GetSubmitRequestSchema (string serviceId, string serviceType) |
Get submitting request schema |
|
Flow_GetUpdateRequestSchema (string serviceId, string serviceType) |
Get updating request schema |
|
Flow_GetViewRequestSchema (string serviceId, string serviceType) |
Get viewing request schema |
|
Get update office365 setting schema |
|
|
Get view request schema |
|
|
Get service names |
|
|
Get service types |
|
|
List workspaces |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Delete web hook
Description: Delete web hook by id.
Syntax:
AvePointCloudGovernance.Flow_DeleteHookById (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string(uuid) (Web Hook Id) |
Id of the web hook. |
True |
Returns:
Summary: Get object status
Description: Get all statuses of object.
Syntax:
AvePointCloudGovernance.Flow_GetObjectStatus ()
Returns:
Type:array of (StringModel)
Summary: Get object types
Description: Get all types of object.
Syntax:
AvePointCloudGovernance.Flow_ObjectTypes ()
Returns:
Type:array of (StringModel)
Summary: Get office365 action types
Description: Get office365 action types.
Syntax:
AvePointCloudGovernance.Flow_GetOffice365ActionTypes ()
Returns:
Type:array of (StringModel)
Summary: Update Microsoft 365 settings
Description: Update Microsoft 365 settings.
Syntax:
AvePointCloudGovernance.Flow_UpdateOffice365Setting (string actionType, Flow_UpdateOffice365SettingParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
actionType |
string (Action Type) |
Specify an action type. |
True |
|
|
body |
Flow_UpdateOffice365SettingParameterBody
|
|
True |
Returns:
Summary: Get sharing domain restriction modes
Description: Get sharing domain restriction modes.
Syntax:
AvePointCloudGovernance.Flow_GetSharingDomainRestrictionModes ()
Returns:
Type:array of (StringModel)
Summary: Get a request
Description: Get details of a request.
Syntax:
AvePointCloudGovernance.Flow_GetRequestById (string serviceType, string serviceId, string requestId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
serviceType |
string (Service Type) |
Type of the service. |
True |
|
|
serviceId |
string (Service Name) |
Name of the service. |
True |
|
|
requestId |
string(uuid) (Request ID) |
Unique ID of the request. |
True |
Returns:
Type:Flow_GetRequestByIdResponse
Summary: Submit a request
Description: Submit a request for a specific service.
Syntax:
AvePointCloudGovernance.Flow_SubmitRequest (string serviceType, string serviceId, [Optional]string DelegateUserPrincipalName, Flow_SubmitRequestParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
serviceType |
string (Service Type) |
Type of the service. |
True |
|
|
serviceId |
string (Service Name) |
Name of the service. |
True |
|
|
DelegateUserPrincipalName |
string (Requester Username) |
Username of the requester. |
False |
|
|
body |
Flow_SubmitRequestParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: Update a request
Description: Update an existing request.
Syntax:
AvePointCloudGovernance.Flow_EditRequest (string serviceType, string serviceId, string id, Flow_EditRequestParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
serviceType |
string (Service Type) |
Type of the service. |
True |
|
|
serviceId |
string (Service Name) |
Name of the service. |
True |
|
|
id |
string(uuid) (Request ID) |
Unique ID of the request. |
True |
|
|
body |
|
|
True |
Returns:
Summary: Get submitting request schema
Description: Get schema for submitting request.
Syntax:
AvePointCloudGovernance.Flow_GetSubmitRequestSchema (string serviceId, string serviceType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
serviceId |
string (Service ID) |
Unique ID of the service. |
True |
|
|
serviceType |
string (Service Type)Values: [CustomService, CreateTeams] |
Type of the service. |
True |
Returns:
Type:FlowSchemaResponse
Summary: Get updating request schema
Description: Get schema for updating request.
Syntax:
AvePointCloudGovernance.Flow_GetUpdateRequestSchema (string serviceId, string serviceType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
serviceId |
string (Service ID) |
Unique ID of the service. |
True |
|
|
serviceType |
string (Service Type)Values: [CustomService, CreateTeams] |
Type of the service. |
True |
Returns:
Type:FlowSchemaResponse
Summary: Get viewing request schema
Description: Get schema for viewing request.
Syntax:
AvePointCloudGovernance.Flow_GetViewRequestSchema (string serviceId, string serviceType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
serviceId |
string (Service ID) |
Unique ID of the service. |
True |
|
|
serviceType |
string (Service Type)Values: [CustomService, CreateTeams] |
Type of the service. |
True |
Returns:
Type:FlowSchemaResponse
Summary: Get update office365 setting schema
Description: Get schema for update office365 setting.
Syntax:
AvePointCloudGovernance.Flow_GetUpdateOffice365SettingSchema (string actionType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
actionType |
string (Flow_TitleCase_Office365ActionType)Values: [UpdateSiteExternalDomain] |
Flow_Office365ActionType_Des |
True |
Returns:
Type:FlowSchemaResponse
Summary: Get view request schema
Description: Get schema for workspace.
Syntax:
AvePointCloudGovernance.Flow_GetWorkspaceSchema ([Optional]string workspaceType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
workspaceType |
string (Workspace Type)Values: [All, Site, Group, Teams] |
Type of workspace. |
False |
Returns:
Type:FlowSchemaResponse
Summary: Get service names
Description: Get service names by specific type.
Syntax:
AvePointCloudGovernance.Flow_GetServiceNamesByType ([Optional]string serviceType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
serviceType |
string (Service Type)Values: [CustomService, CreateTeams] |
Type of the service. |
False |
Returns:
Type:array of (StringModel)
Summary: Get service types
Description: Get supported service types.
Syntax:
AvePointCloudGovernance.Flow_GetServiceTypes ()
Returns:
Type:array of (StringModel)
Summary: List workspaces
Description: Retrieve a list of workspaces managed by Cloud Governance.
Syntax:
AvePointCloudGovernance.Flow_ListWorkspace ([Optional]string workspaceType, [Optional]string primaryContact, [advanced][Optional]string status, [advanced][Optional]string urlorIdorEmail, [advanced][Optional]string secondaryContact, [advanced][Optional]integer top, [advanced][Optional]string nextLink)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
workspaceType |
string (Workspace Type) |
Filter by the workspace type. |
False |
|
|
primaryContact |
string (Primary Workspace Contact) |
Filter by the primary workspace contact. |
False |
|
|
status |
string (Workspace Status) |
Filter by the workspace status. |
False |
|
|
urlorIdorEmail |
string (Workspace URL or E-mail Address) |
Filter by the workspace URL or e-mail address. |
False |
|
|
secondaryContact |
string (Secondary Workspace Contact) |
Filter by the secondary workspace contact. |
False |
|
|
top |
integer(int32) (Workspace Count) |
Number of workspaces to retrieve (default = 2000, maximum = 3000). |
False |
|
|
nextLink |
string (Next Token) |
Use the next token to retrieve remaining workspaces that have not been listed here. |
False |
Returns:
Type:Flow_ListWorkspaceResponse
Summary: When an error task is generated
Description: This operation triggers when an error task is generated.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForErrorTaskCreated (Flow_CreateHookForErrorTaskCreatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForErrorTaskCreatedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When an error task is retried
Description: This operation triggers when the retry action is performed on an error task.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForErrorTaskRetried (Flow_CreateHookForErrorTaskRetriedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForErrorTaskRetriedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When a request is canceled
Description: This operation triggers when a request is canceled.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForRequestCancelled (Flow_CreateHookForRequestCancelledParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForRequestCancelledParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When a request is completed
Description: This operation triggers when a request is completed.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForRequestCompleted (Flow_CreateHookForRequestCompletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForRequestCompletedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When a request is submitted
Description: This operation triggers when a request is submitted.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForRequestSubmitted (Flow_CreateHookForRequestSubmittedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForRequestSubmittedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When a request is approved
Description: This operation triggers when a request is approved.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForTaskApproved (Flow_CreateHookForTaskApprovedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForTaskApprovedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When an import process with pre-defined governance details is completed
Description: This operation triggers when an import process with pre-defined governance details is completed.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForFullyAutoImportCompleted (Flow_CreateHookForFullyAutoImportCompletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForFullyAutoImportCompletedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When an end user completes a governance details confirmation task
Description: This operation triggers when an end user completes a governance details confirmation task for a workspace.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForConfirmDetailCompleted (Flow_CreateHookForConfirmDetailCompletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForConfirmDetailCompletedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When an approval task is assigned
Description: This operation triggers when an approval task is assigned.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForTaskCreated (Flow_CreateHookForTaskCreatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForTaskCreatedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When a request is rejected
Description: This operation triggers when a request is rejected.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForTaskRejected (Flow_CreateHookForTaskRejectedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForTaskRejectedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When a renewal task is completed
Description: This operation triggers when a renewal task is completed.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForRenewalTaskCompleted (Flow_CreateHookForRenewalTaskCompletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForRenewalTaskCompletedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When a renewal process encounters an exception
Description: This operation triggers when a renewal process encounters an exception.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForRenewalTaskException (Flow_CreateHookForRenewalTaskExceptionParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForRenewalTaskExceptionParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When a renewal task is overdue
Description: This operation triggers when a renewal task is overdue.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForRenewalTaskOverdue (Flow_CreateHookForRenewalTaskOverdueParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForRenewalTaskOverdueParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary: When an error task is skipped
Description: This operation triggers when the skip action is performed on an error task.
Syntax:
AvePointCloudGovernance.Flow_CreateHookForErrorTaskSkipped (Flow_CreateHookForErrorTaskSkippedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Flow_CreateHookForErrorTaskSkippedParameterBody
|
|
True |
Returns:
Type:string(uuid)
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Trigge Url |
Url of trigger. |
|
triggerType |
string Trigger Type |
Type of trigger. Values: [None, RequestSubmitted, RequestCompleted, RequestCancelled, TaskCreated, TaskApproved, TaskRejected, ErrorTaskCreated, TaskRetried, TaskSkipped, RenewalSuccess, RenewalException, RenewalOverdue, FullyAutoImportSuccess, ConfirmDetailSuccess] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
name |
string
|
|