This article provides information on how to use the out-of-the-box task library components within MSPComplete.

---

Add Users To Groups

Adds users into a group or users into multiple groups using a CSV

Inputs

Usage option 1: Add one or more users into a group

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

  The OrganizationName extended property is required - it is the portion of the domain before the '.onmicrosoft.com'

  Example: If the full domain is 'mydomain.onmicrosoft.com', the OrganizationName is 'mydomain'.

• Users

  One or more MSPComplete user objects are required.

  The users to add to the specified SharePoint Online site collection group

• GroupName

  Single string; required.

  The name of the group

• URL

  Single string; required.

  The URL of the SharePoint Online site collection

Usage option 2: Add users into multiple groups using a CSV

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

  The OrganizationName extended property is required - it is the portion of the domain before the '.onmicrosoft.com'

  Example: If the full domain is 'mydomain.onmicrosoft.com', the OrganizationName is 'mydomain'.

• UsersCsv

  A CSV containing information about the users, groups, and sites.

  Required columns:

  • PrimaryEmailAddress

    The primary email address uniquely identifying a user

  • GroupName

    The name of the group

  • URL

    The URL of the SharePoint Online site collection

Outputs

• SharePointOnlineAddUsersToGroupsProcessedUsersCsv

  A CSV string containing the information about which users were successfully added to the specified groups via an additional column 'AddedToGroup'.

• SharePointOnlineAddUsersToGroupsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.1.1

Date: 14 March 2019

---

Assign/Unassign Members As Site Collection Administrator

Assigns or unassigns one or more users as Site Collection Administrator for a site or assigns and unassigns users as Site Collection Administrator for SharePoint Online sites via a CSV

Inputs

Usage option 1: Assigns or unassigns one or more users as Site Collection Administrator for a specified SharePoint Online site

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• Users

  One or more MSPComplete user objects; required

• URL

  Single string; required

  The URL of the SharePoint Online site to assign/unassign Site Collection Administrators

• IsSiteCollectionAdmin

  Single bool; required

  True to assign as an administrator, false to unassign

Usage option 2: Assigns and unassigns users as Site Collection Administrators for SharePoint Online sites using a CSV

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• UsersCsv

  Required columns:

  • PrimaryEmailAddress

    The primary email address uniquely identifying a user

  • URL

    The URL of the SharePoint Online site

  • IsSiteCollectionAdmin

    Either 'true' to assign a user as an administrator or 'false' to unassign

Outputs

• SharePointOnlineAssignUnassignMembersAsSiteCollectionAdministratorProcessedUsersCsv

  A CSV string containing the information about which users were successfully assigned or unassigned via an additional column 'Updated'.

• SharePointOnlineAssignUnassignMembersAsSiteCollectionAdministratorErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.2.2

Date: 16 March 2019

---

Create Groups

Create a group with an owner for a SharePoint Online site or create groups with owners for SharePoint Online sites via CSV format

Inputs

Usage option 1: Create a group with an owner for a SharePoint Online site collection

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• URL

  Single string; required.

  The URL of the SharePoint Online site collection to create the group.

• GroupName

  Single string; required.

  The name of the SharePoint Online Group.

• GroupOwner

  Single MSPComplete user object; optional.

  The user to be set as the owner of the SharePoint Online group.

• PermissionLevels

  One or more strings, separated by a new line are required.

  The permissions for the SharePoint Online group. The possible values are Full Control, Design, Edit, Contribute, and Read.

Usage option 2: Create groups with owners for SharePoint Online sites

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials; is required.

• GroupsCsv

  Required columns:

  • URL

    The URL of the SharePoint Online site collection.

  • GroupName

    The name of the SharePoint Online group to create.

  • PermissionLevels

    The permissions given to the group, with each permission separated by commas and enclosed in quotation marks, e.g. "Contribute, Read".

    The possible permission levels are Full Control, Design, Edit, Contribute, and Read.

  Optional columns:

  • GroupOwnerPrimaryEmailAddress

    The primary email address uniquely identifies a user to be set as the group owner.

Outputs

• SharePointOnlineCreateGroupsProcessedGroupsCsv

  A CSV string containing the information about which groups were successfully created via an additional column 'Created'.

• SharePointOnlineCreateGroupsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.1.1

Date: 14 March 2019

Back to top

---

Create Site Collections

Creates a SharePoint Online site collection or multiple site collections via CSV format

Inputs

Usage option 1: Create a SharePoint Online site collection

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• Owner

  Single MSPComplete user object; required.

  Owner of the SharePoint Online site collection.

• CompatibilityLevel

  Single string; optional.

  Either 14 (Compatible with SharePoint 2010) or 15 (SharePoint 2013).

• LocaleId

  Single string; optional.

  The language for the site collection. Use cmdlet Get-SPOWebTemplate for the list of valid combinations in conjunction with Template.

• ResourceQuota

  Single string; optional.

  The quota for the site collection with the default value is set as 0. View Microsoft's documentation on New-SPOSite for more information.

• StorageQuotaMegabytes

  Single string; required.

  The total storage size for the site collection in megabytes.

• Template

  Single string; optional.

  The site collection template to use when creating the site. Use cmdlet Get-SPOWebTemplate for the list of valid combinations in conjunction with LocaleId.

• TimeZoneId

  Single string; optional.

  The time zone for the site collection.

• Title

  Single string; optional.

  The title for the site collection.

• URL

  Single string; required.

  The URL for the site collection.

Usage option 2: Creates SharePoint Online site collections

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials; is required.

• SiteCollectionsCsv

  Required columns:

  • OwnerPrimaryEmailAddress

    Email address of the primary owner of the SharePoint Online site collection.

  • URL

    The URL for the site collection.

  • StorageQuotaMegabytes

    The total storage size for the site collection is in megabytes.

  Optional columns:

  • CompatibilityLevel

    Either 14 (Compatible with SharePoint 2010) or 15 (SharePoint 2013).

  • LocaleId

    The language for the site collection.

    Use cmdlet Get-SPOWebTemplate for the list of valid combinations in conjunction with Template.

  • ResourceQuota

    The quota for the site collection with the default value is set as 0.

    View Microsoft's documentation on New-SPOSite for more information.

  • Template

    The site collection template to use when creating the site.

    Use cmdlet Get-SPOWebTemplate for the list of valid combinations in conjunction with LocaleId.

  • TimeZoneId

    The time zone for the site collection.

  • Title

    The title for the site collection

Outputs:

• SharePointOnlineCreateSiteCollectionsProcessedSiteCollectionsCsv

  A CSV string containing the information about which sites were successfully created via an additional column 'Created'.

• SharePointOnlineCreateSiteCollectionsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.1.1

Date: 14 March 2019

Back to top

---

Delete Groups

Delete a SharePoint Online site collection group or groups from specified SharePoint Online site collections via CSV format

Inputs

Usage option 1: Delete a SharePoint Online site collection group

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• GroupName

  Single string; required.

  The name of the SharePoint Online group to delete.

• URL

  Single string; required.

  The URL of the SharePoint Online site to delete the group from.

Usage option 2: Delete groups from the specified SharePoint Online site collections

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• GroupsCsv

  Required columns:

  • GroupName

    The name of the SharePoint Online group to delete

  • URL

    The URL of the SharePoint Online site to delete the group from

Outputs

• SharePointOnlineDeleteGroupsProcessedGroupsCsv

  A CSV string containing the information about which groups were successfully deleted via an additional column 'Deleted'.

• SharePointOnlineDeleteGroupsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.2.1

Date: 14 March 2019

Back to top

---

Delete Site Collections

Deletes one or more site collections in SharePoint Online.

By default, the site collections are moved to the Recycle Bin on SharePoint Online.

If PermanentlyDelete is set to true, the site collections are permanently deleted from the Recycle Bin as well.

Inputs

Usage option 1: Delete a SharePoint Online site collection

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• URL

  Single string; required.

  The URL of the SharePoint Online site collection to delete.

• PermanentlyDelete

  Single bool; optional.

Usage option 2: Delete SharePoint Online site collections

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• SiteCollectionsCsv

  Required columns:

  • URL

    The URL of the SharePoint Online site collection to delete.

  Optional columns:

  • PermanentlyDelete

    Valid values are 'true' or 'false'.

Outputs

• SharePointOnlineDeleteSiteCollectionsProcessedSiteCollectionsCsv

  A CSV string containing the information about which site collections were successfully deleted via an additional column 'Deleted'.

• SharePointOnlineDeleteSiteCollectionsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.2.1

Date: 14 March 2019

Back to top

---

Remove Users From Groups

Removes users from a group or users from multiple groups using a CSV

Inputs

Usage option 1: Removes one or more users from a group

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• Users

  One or more MSPComplete user objects are required.

• GroupName

  Single string; required

  The name of the group

• URL

  Single string; required.

  The URL of the SharePoint Online site collection.

Usage option 2: Removes users from multiple groups using a CSV

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• UsersCsv

  Required columns:

  • PrimaryEmailAddress

    The primary email address uniquely identifies a user.

  • GroupName

    The name of the group.

  • URL

    The URL of the SharePoint Online site collection.

Outputs

• SharePointOnlineRemovedUsersFromGroupsProcessedUsersCsv

  A CSV string containing the information about which users were successfully removed from the specified groups via an additional column 'RemovedFromGroup'.

• SharePointOnlineRemovedUsersFromGroupsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.1.1

Date: 14 March 2019

Back to top

---

Restore Deleted Site Collections

Restores deleted SharePoint Online site collections from the Recycle Bin

Inputs

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• URLs

  Multiple string values, separated by a new line are required.

  The URLs of the SharePoint Online site collections to be restored.

Outputs

• SharePointOnlineRestoreDeletedSiteCollectionsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.0.2

Date: 14 March 2019

Back to top

---

Retrieve Deleted Site Collections

Retrieves SharePoint Online site collections in the Recycle Bin as a CSV string

Inputs

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• IncludePersonalSites

  Single bool; optional.

Outputs

• SharePointOnlineDeletedSiteCollectionsCsv

  CSV containing the URL, deletion time, days remaining, and storage quota information of the deleted site collections

Version: 1.0.1

Date: 14 March 2019

Back to top

---

Retrieve Groups

Retrieves login, title, owner, users, and role information in CSV format for a group or groups in site collections using a CSV

Inputs

Usage option 1: Retrieve information for a group

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• GroupName

  Single string; required.

  The name of the group.

• URL

  Single string; required.

  The URL of the SharePoint Online site collection.

Usage option 2: Retrieve information for groups in specified site collections

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• GroupsCsv

  Required columns:

  • GroupName

    The name of the group.

  • URL

    The URL of the SharePoint Online site collection.

Outputs

• SharePointOnlineGroupPropertiesCsv

  CSV containing the Login name, title, owner, user, and role information of the group

• SharePointOnlineRetrieveGroupsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.0.2

Date: 14 March 2019

Back to top

---

Retrieve Site Collections For Users

Retrieves SharePoint Online site collections containing the provided users

Inputs

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• Users

  One or more MSPComplete user objects are required.

Outputs

• SharePointOnlineSiteCollectionsCsv

  The list of site collections that contain the provided users.

  Additional information includes the URL, user's display name and email address, and site collection group they belong in

• SharePointOnlineRetrieveSiteCollectionsForUsersErrorMessagessnipp

  A string containing all the error messages that were generated over the course of this task.

Version: 1.0.2

Date: 14 March 2019

Back to top

---

Retrieve Site Collections' Statistics

Retrieves statistics about SharePoint Online site collections as a CSV string

Inputs

Usage option 1: Add one or more users into a group

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• URLs

  Multiple string values, separated by a new line are required.

  The URLs of the SharePoint Online site collections to retrieve statistics on

Outputs

• SharePointOnlineSiteCollectionsCsv

  A CSV string containing statistics about the provided SharePoint Online site collections

• SharePointOnlineRetrieveSiteCollectionsStatisticsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.0.2

Date: 14 March 2019

Back to top

---

Retrieve Users In Site Collections

Retrieves SharePoint Online site collection users' information as a CSV string

Inputs

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

• URLs

  Multiple strings separated by a new line; optional

  The URL of the SharePoint Online site collection

Outputs

• SharePointOnlineUsersCsv

  The list of users in the provided SharePoint Online site collection URLs

• SharePointOnlineRetrieveUsersInSiteCollectionsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.1.1

Date: 14 March 2019

Back to top

---

Update Site Collections' Sharing Settings

Updates the sharing settings of one or more site collections in SharePoint Online.

This task makes use of the Set-SPOSite cmdlet to update the various settings.

Inputs

Usage option 1: Update the settings of a SharePoint Online site collection

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials is required.

  The OrganizationName extended property is required - it is the portion of the domain before the '.onmicrosoft.com'.

  Example: If the full domain is 'mydomain.onmicrosoft.com', the OrganizationName is 'mydomain'.

• URL

  Single string; required.

  The URL of the SharePoint Online site collection.

• DefaultLinkPermission

  Single string; optional.

  This sets the default link permission for the site collection.

  Possible values are 'None', 'View', and 'Edit'.

  This property is not modified if not specified.

  • None - Respects the default organization link permission.

  • View - The default link permission is 'view'.

  • Edit - The default link permission is 'edit'.

• DefaultSharingLinkType

  Single string; optional.

  This sets the default link type for the site collection.

  Possible values are 'None', 'AnonymousAccess', 'Internal', and 'Direct'.

  This property is not modified if not specified.

  • None - Respects the default organization link type.

  • AnonymousAccess - The default link type is 'Anonymous Access' or anyone.

  • Internal - The default link type is 'Organization' or company shareable.

  • Direct - The default link type is 'Specific People'.

• SharingAllowedDomainList

  One or more strings separated by a new line; optional.

  This specifies a list of email domains that are allowed as external collaborators.

  This property is not modified if not specified.

  To clear the existing list, use the value of $CLEAR_VALUE_FLAG as defined in BitTitan.Runbooks.Common.

• SharingBlockedDomainList

  One or more strings separated by a new line; optional.

  This specifies a list of email domains that are blocked as external collaborators.

  This property is not modified if not specified.

  To clear the existing list, use the value of $CLEAR_VALUE_FLAG as defined in BitTitan.Runbooks.Common.

• SharingCapability

  Single string; optional.

  This sets the level of sharing available for the site collection.

  Possible values are 'Disabled', 'ExistingExternalUserSharingOnly', 'ExternalUserSharingOnly', and 'ExternalUserAndGuestSharing'.

  This property is not modified if not specified.

  • Disabled - Sharing outside the organization is not allowed.

  • ExistingExternalUserSharingOnly - Sharing with external users is only allowed if they already exist in the organization's directory.

  • ExternalUserSharingOnly - Sharing with external users is allowed if they sign in as authenticated users.

  • ExternalUserAndGuestSharing - Sharing with external users and using anonymous access links is allowed.

• SharingDomainRestrictionMode

  Single string; optional.

  This selects whether the domain 'Allow' or 'Block' list, or neither, is used to control external sharing.

  Possible values are 'None', 'AllowList', and 'BlockList'.

  This property is not modified if not specified.

  • None - Neither the 'Allow' nor 'Block' list is used.

  • AllowList - The 'Allow' list is used.

  • BlockList - The 'Block' list is used.

Usage option 2: Update the settings of multiple SharePoint Online site collections using a CSV

• Office365AdministrativeCredentials

  An MSPComplete endpoint object containing the Office 365 administrative credentials; required.

  The OrganizationName extended property is required - it is the portion of the domain before the '.onmicrosoft.com'

  Example: If the full domain is 'mydomain.onmicrosoft.com', the OrganizationName is 'mydomain'.

• SiteCollectionsCsv

  Required columns:

  • URL

    The URL of the SharePoint Online site collection

  Optional columns:

  • DefaultLinkPermission

  • DefaultSharingLinkType

  • SharingAllowedDomains

    One or more strings separated by a comma, with the whole string surrounded by quotes.

    Example: "mydomain.com,fabrikam.com"

  • SharingBlockedDomains

    One or more strings separated by a comma, with the whole string surrounded by quotes.

    Example: "mydomain.com,fabrikam.com"

  • SharingCapability

  • SharingDomainRestrictionMode

Outputs

• SharePointOnlineUpdateSiteCollectionsSharingSettingsErrorMessages

  A string containing all the error messages that were generated over the course of this task.

Version: 1.1

Date: 16 January 2019

Back to top