Office 365 Tasks

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

Tasks


Add/Remove Domains from Tenant

Adds or removes domains from the Office 365 tenant

Inputs:

Usage option 1: Add or remove a set of domains from the tenant

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Domains - required

    One or more strings separated by a new line.

    The domains to add or remove from the tenant.

    The domain names need to be fully qualified domain names (FQDNs).

  • AddOrRemoveDomains - required

    A single string.

    Specifies if the domains will be added or removed from the tenant.

    Valid values are 'Add' and 'Remove' (case insensitive).

Usage option 2: Add or remove domains from the tenant using a CSV string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • DomainsCsv - required

    A CSV string containing information about the domains to add or remove from the tenant.

    Required columns:

    Domain

    A single string.

    The domain to add or remove from the tenant.

    The domain name needs to be a be fully qualified domain name (FQDNs).

    AddOrRemoveDomain

    A single string.

    Specifies if the domain will be added or removed from the tenant.

    Valid values are 'Add' and 'Remove' (case insensitive).

Outputs:

  • Office365AddRemoveDomainsFromTenantCsv

    A CSV string containing information about the domains which were added or removed from the tenant.

    The additional column 'AddRemoveDomainsFromTenantOperationApplied' indicates if the action to add or remove the domain was executed by this task.

    The additional column 'AddRemoveDomainsFromTenantStateAchieved' indicates if the at the end of the task the domains to be added were present, and the domains to be removed were not present.

    The additional column 'AddRemoveDomainsFromTenantMessages' contains the warning and/or error messages which were generated while adding or removing the domain.

    If the domain was added to the tenant but has not been verified, either a MX record or a TXT record will need to be created in the DNS provider for the domain to verify the domain ownership.

    The additional column 'DomainDnsVerificationMxLabel' shows the label of the MX record.

    The additional column 'DomainDnsVerificationMxMailExchange' shows the mail exchange of the MX record.

    The additional column 'DomainDnsVerificationMxPreference' shows the preference of the MX record.

    The additional column 'DomainDnsVerificationMxTtl' shows the TTL of the MX record.

    The additional column 'DomainDnsVerificationTxtLabel' shows the label of the TXT record.

    The additional column 'DomainDnsVerificationTxtText' shows the value of the TXT record.

    The additional column 'DomainDnsVerificationTxtTtl' shows the TTL of the TXT record.

  • Office365AddRemoveDomainsFromTenantErrorMessages

    A string containing the error messages which were generated over the course of the task.

Version: 1.0.0

Date: 8 May 2019

Back to top


Add/Remove Email Forwarding

Adds/Removes email forwarding on one or more Office 365 accounts

Inputs:

Usage option 1: Add or Remove email forwarding for a user mailbox

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint.

    The Office 365 administrative credentials for the tenant.

  • User - required

    A single MSPComplete user object.

    The user to set email forwarding on.

  • ForwardingEmailAddress - optional

    A single string.

    The forwarding email address. If this is not provided, email forwarding will be removed for the user.

  • DeliverToMailboxAndForward - optional

    A single boolean variable.

    Specifies if mail will be delivered to the mailbox prior to forwarding.

    Defaults to false.

Usage option 2: Add or Remove email forwarding for an email address

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint.

    The Office 365 administrative credentials for the tenant.

  • EmailAddress - required

    A single string.

    The email address to forward emails from.

  • ForwardingEmailAddress - optional

    A single string.

    The forwarding email address. If this is not provided, email forwarding will be removed for the email account.

  • DeliverToMailboxAndForward - optional

    A single boolean variable.

    Specifies if mail will be delivered to the mailbox prior to forwarding.

    Defaults to false.

Usage option 3: Add or Remove email forwarding for an email address using a CSV

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint.

    The Office 365 administrative credentials for the tenant.

  • UsersEmailForwardingCsv - required

    A CSV containing the information about what email accounts to add or remove forwarding on.

    Required columns:

    EmailAddress

    A single string.

    The email address to forward emails from.

    ForwardingEmailAddress

    A single string.

    The forwarding email address. If this is not provided, email forwarding will be removed for the email account.

    Optional columns:

    DeliverToMailboxAndForward

    A single string variable.

    Specifies if mail will be delivered to the mailbox prior to forwarding.

    Valid values are 'true' and 'false' (case insensitive).

    Defaults to false.

Outputs:

  • Office365AddRemoveEmailForwardingCsv

    A CSV string containing the information about which users/email accounts have been successfully updated with email forwarding added or removed via column 'UserUpdated'.

  • Office365AddRemoveEmailForwardingErrorMessages

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

Version: 1.2.3

Date: 18 June 2019

Back to top


Add/Remove Members from Distribution Groups

Adds or removes members from Office 365 distribution groups.

The members which can be added or removed from the groups can be users or even other distribution groups.

Inputs:

Usage option 1: Add or remove a user as a member from one or more distribution groups

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the members and groups.

  • AddOrRemoveMember - required.

    A single string.

    Specifies if the user will be added or removed as members of the distribution groups.

    Valid values are 'add' and 'remove' (case insensitive).

  • DistributionGroup - required

    One or more MSPComplete group objects.

    These are the groups which the user will be added/removed from as a member.

    All of the group objects need to have a 'PrimaryEmailAddress' extended property, which is the group's email address in Office 365.

  • MemberUsers - required

    A single MSPComplete end user object.

    This is the user which will be added/removed from the group as members.

Usage option 2: Add or remove a group as a member from one or more distribution groups

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the members and groups.

  • AddOrRemoveMember - required.

    A single string.

    Specifies if the group will be added or removed as members of the distribution groups.

  • DistributionGroup - required

    One or more MSPComplete group objects.

    These are the groups which the group will be added/removed from as a member.

    All of the group objects need to have a 'PrimaryEmailAddress' extended property, which is the group's email address in Office 365.

  • MemberGroups - required

    A single MSPComplete group object.

    This is the group which will be added/removed from the groups as a member.

    The group object needs to have a 'PrimaryEmailAddress' extended property, which is the group's email address in Office 365.

Usage option 3: Add or remove one or more users as members from a distribution group

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the members and groups.

  • AddOrRemoveMember - required.

    A single string.

    Specifies if the users will be added or removed as members of the distribution group.

  • DistributionGroup - required

    A single MSPComplete group object.

    These is the group which the users will be added/removed from as members.

    The group object needs to have a 'PrimaryEmailAddress' extended property, which is the group's email address in Office 365.

  • MemberUsers - required

    One or more MSPComplete end user objects.

    These are the users which will be added/removed from the group as members.

Usage option 4: Add or remove one or more groups as members from a distribution group

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the members and groups.

  • AddOrRemoveMember - required.

    A single string.

    Specifies if the groups will be added or removed as members of the distribution group.

  • DistributionGroup - required

    A single MSPComplete group object.

    These is the group which the groups will be added/removed from as members.

    The group object needs to have a 'PrimaryEmailAddress' extended property, which is the group's email address in Office 365.

  • MemberGroups - required

    One or more MSPComplete group objects.

    They are the groups which will be added/removed from the group as members.

    All of the group objects need to have a 'PrimaryEmailAddress' extended property, which is the group's email address in Office 365.

Usage option 5: Add or remove users or groups as members from distribution groups via CSV

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the members and groups.

  • MembersCsv - required

    A CSV string containing information about the members to add or remove from the distribution groups.

    Required columns:

    DistributionGroupPrimaryEmailAddress

    A single string.

    The primary email address of the distribution group.

    AddOrRemoveMember

    A single string.

    Specifies if the member will be added or removed from the distribution group.

    Valid values are 'add' and 'remove' (case insensitive).

    MemberPrimaryEmailAddress

    A single string.

    The primary email address of the member to add or remove from the distribution group.

Outputs:

  • Office365AddRemoveMembersFromDistributionGroupsCsv

    A CSV string containing information about the members which were added/removed from the distribution groups

    The additional column 'AddRemoveMembersFromDistributionGroupsOperationApplied' indicates if the action to add or remove members was successfully executed by this task.

    The additional column 'AddRemoveMembersFromDistributionGroupsStateAchieved' indicates if the desired state was achieved.

    The additional column 'AddRemoveMembersFromDistributionGroupsMessages' contains the warning/error messages which were generated during the course of the task.

  • Office365AddRemoveMembersFromDistributionGroupsErrorMessages

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

Version: 1.2.0

Date: 15 May 2019

Back to top


Add/Remove Users from Unified Groups

Adds or removes users from Office 365 unified groups.

Inputs:

Usage option 1: Add or remove one or more users from one or more unified groups

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • AddOrRemoveUsers - required

    A single string.

    This specifies whether the users will be added to or removed from the group.

    Valid values are 'add' and 'remove' (case insensitive).

  • UnifiedGroups - required

    One or more MSPComplete group objects.

    This is the group(s) which the user will be added/removed from.

    The group objects need to have a 'PrimaryEmailAddress' extended property, which is the group's email address in Office 365.

  • Users - required

    One or more MSPComplete end user objects.

    They are the users which will be added/removed from the group.

  • LinkType - optional

    A single string.

    This is the user role within the group.

    Valid values are 'Members', 'Owners', 'Subscribers' (case insensitive).

    Defaults to 'Members'.

Usage option 2: Add or remove users or groups as users from unified groups via CSV

  • Office365AdministrativeCredentials - required

    A MSPComplete endpoint object containing the Office 365 administrative credentials.

    The credentials for the tenant to complete the operation on.

  • UsersCsv - required

    A CSV string containing information about the users to add or remove from the unified groups.

    Required columns:

    UnifiedGroupPrimaryEmailAddress

    A single string.

    The primary email address of the unified group.

    AddOrRemoveUsers

    A single string.

    This specifies whether the user is added to or removed from the group.

    Valid values are 'add' and 'remove' (case insensitive).

    UserPrimaryEmailAddress

    A single string.

    The primary email address of the user to add or remove from the unified group.

    Optional columns:

    LinkType

    A single string.

    The user role within the group.

    Valid values are 'Members', 'Owners', 'Subscribers' (case insensitive).

    Defaults to 'Members'.

Outputs:

  • Office365AddRemoveUsersFromUnifiedGroupsCsv

    A CSV string containing information about the users which were added/removed from the unified groups.

    The additional column 'AddRemoveUsersFromUnifiedGroupsOperationApplied' indicates if the action to add or remove the user from the unified group was successfully executed by this task.

    The additional column 'AddRemoveUsersFromUnifiedGroupsStateAchieved' indicates if at the end of the task the user to add is in the group, or the user to remove is not in the group.

    The additional column 'AddRemoveUsersFromUnifiedGroupsMessages' contains the warning and/or error messages which were generated while updating membership information.

  • Office365AddRemoveUsersFromUnifiedGroupsErrorMessages

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

Version: 1.1.0

Date: 24 May 2019

Back to top


Assign Licenses to Users

Assigns licenses to one or more Office 365 users

Inputs:

Usage option 1: Assign licenses to a user

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the users.

  • Users - required

    A single MSPComplete end user object.

    The user which will receive the licenses.

    If more than one object is provided, only the first one is used.

  • Licenses - optional

    One or more strings separated by a new line.

    The SKU IDs or SKU part numbers for the licenses to assign.

    If this is not specified, no licenses will be assigned to the user.

    Example license SKU ID: reseller-account:ENTERPRISEPREMIUM

    Example SKU part number: ENTERPRISEPREMIUM

Usage option 2: Assign a license to multiple users

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the users.

  • Users - required

    More than one MSPComplete end user object.

    The users which will receive the license.

  • Licenses - optional

    A single string.

    The SKU ID or SKU part number for the license to assign.

    If this is not specified, no licenses will be assigned to the users.

    Example license SKU ID: reseller-account:ENTERPRISEPREMIUM

    Example SKU part number: ENTERPRISEPREMIUM

Usage option 3: Assign licenses to multiple users using a CSV string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the users.

  • UserLicensesCsv - required

    Required columns:

    PrimaryEmailAddress

    A single string.

    The primary email address of the user to receive the license.

    Optional columns:

    License

    A single string.

    The SKU ID or SKU part number for the license to assign.

    If more than one license is to be assigned to this user, multiple rows should be created in the CSV, one for each license.

    If this is not specified, no license will be assigned to this user.

Outputs:

  • Office365AssignLicensesToUsersCsv

    A CSV containing all the users which were processed by this task, as well as an additional column 'AssignedLicenses' to indicate if the licenses were assigned successfully.

  • Office365AssignLicensesToUsersErrorMessages

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

Version: 1.2.0

Date: 17 May 2019

Back to top


Assign/Unassign User Roles

Assigns or unassigns roles to Office 365 users

Inputs:

Usage option 1: Assign or unassign a set of roles to one or more users

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Roles - required

    One or more strings separated by a new line.

    The names of the roles which will be assigned to the users.

    To get a list of the roles which can be assigned to the users, use "Get-MsolRole | Sort-Object Name | Select-Object Name, Description".

  • Users - required

    One or more MSPComplete end user objects.

    The users which will be the target of the role assignments/unassignments.

  • AssignOrUnassignRoles - required

    A single string.

    Specifies if the roles should be assigned or unassigned.

    Valid values are 'Assign' and 'Unassign' (case insensitive).

Usage option 2: Assign or unassign roles to users using a CSV string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UserRolesCsv

    A CSV string containing the information about the the users and roles which will be assigned or unassigned.

    Required columns:

    • Role

      A single string.

      The name of the role which will be assigned to the user.

      To get a list of the roles which can be assigned to the users, use "Get-MsolRole | Sort-Object Name | Select-Object Name, Description".

    • UserPrimaryEmailAddress

      A single string.

      The primary email address of the user which will be assigned or unassigned the role.

    • AssignOrUnassignRole

      A single string.

      Specifies if the role should be assigned or unassigned.

      Valid values are 'Assign' and 'Unassign' (case insensitive).

Outputs:

  • Office365AssignUnassignUserRolesCsv

    A CSV string containing the information about the users and roles which were assigned or unassigned.

    The column 'AssignUnassignUserRolesOperationApplied' indicates if this task added or removed the user role.

    The column 'AssignUnassignUserRolesStateAchieved' indicates if the user roles to assign were present at the end of the task, and if the user roles to unassign were not present at the end of the task.

    The column 'AssignUnassignUserRolesMessages' contains the warning and/or error messages which were generated while assigning or unassigning the user roles.

  • Office365AssignUnassignUserRolesErrorMessages

    A string containing the error messages which were generated over the course of the task.

Version: 1.0.0

Date: 8 May 2019

Back to top


Block/Unblock Access to Account

Blocks/Unblocks sign-in access to an Office 365 account managed within MSPComplete

Inputs:

Usage option 1: Block or Unblock sign-in access for an Office 365 account

  • Office365AdministrativeCredentials

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

    The credentials for the tenant to complete the operation on

  • User

    A MSPComplete user object, required.

    The user to block or unblock sign-in access

  • ShouldBlockAccount

    Single string, boolean.

    True to block, false to unblock

Outputs:

  • None

Version: 1.0

Date: 6 November 2018

Back to top


Convert Mailboxes to Shared Mailboxes

Converts Office 365 standard mailboxes to shared mailboxes

Inputs:

Usage option 1: Convert Office 365 standard mailboxes into a shared mailboxes using end user objects

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • Mailboxes - required

    One or more MSPComplete end user objects.

    The mailboxes to convert into shared mailboxes.

  • MaximumWaitTimeSeconds - optional

    A single string.

    The maximum amount of time this task will wait for all the mailboxes to be converted to shared mailboxes, in seconds.

    Defaults to "60".

Usage option 2: Convert Office 365 standard mailboxes into shared mailboxes using a CSV string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • MailboxesCsv - required

    A CSV string containing information on the mailboxes to convert to shared mailboxes.

    Required columns:

    PrimaryEmailAddress

    A single string.

    The primary email address of the mailbox to convert to a shared mailbox.

  • MaximumWaitTimeSeconds - optional

    A single string.

    The maximum amount of time this task will wait for all the mailboxes to be converted to shared mailboxes, in seconds.

    Defaults to "60".

Outputs:

  • Office365ConvertMailboxesToSharedMailboxesCsv

    A CSV string containing the information on the mailboxes which were processed, as well as an additional column 'MailboxConvertedToSharedMailbox' to indicate if the mailbox was successfully converted to a shared mailbox.

  • Office365ConvertMailboxesToSharedMailboxesErrorMessages

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

Version: 1.0.1

Date: 18 June 2019

Back to top


Copy User Distribution Group Memberships

Copies an Office 365 user's distribution group memberships to other Office 365 users

The copied distribution group memberships will be in addition to any existing memberships the other user may already have.

For example, copying distribution group memberships from user 1 to user 2 will not remove any of user 2's existing group memberships.

Inputs:

Usage option 1: Copy a user's group memberships to other users

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • ReferenceUser - required

    A single MSPComplete end user object.

    The user which will be used as the reference for distribution group memberships.

    If more than one end user object is provided, only the first one will be used.

  • TargetUsers - required

    One or more MSPComplete end user objects.

    The users which will receive the same distribution group memberships as the reference user.

Usage option 2: Copy users' group memberships to other users

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UsersCsv - required

    A CSV string containing the information about the reference and target users for copying the distribution group memberships.

    Required columns:

    ReferenceUserPrincipalName

    A single string.

    The user principal name of the user which is used as the reference for distribution group memberships.

    TargetUserPrincipalName

    A single string.

    The user principal name of the user which will receive the copy of the distribution group memberships.

Outputs:

  • Office365CopyUserDistributionGroupMembershipsCsv

    A CSV string containing the information about the reference and target users for copying the distribution group memberships.

    It contains an additional column 'CopiedDistributionGroupMemberships' which indicates if the distribution group memberships were copied successfully from the reference user to the target user.

  • Office365CopyUserDistributionGroupMembershipsErrorMessages

    A string containing the error messages which were generated over the course of the task.

Version: 1.0.0

Date: 3 May 2019

Back to top


Create Contacts

Creates Office 365 contacts given the name and email address, or a CSV string.

Inputs:

Usage option 1: Create a contact

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • ContactName - required

    A single string.

    The name of the contact.

    Example: John Doe

  • ContactExternalEmailAddress - required

    A single string.

    The external email address of the contact.

    Example: johndoe@domain.com

Usage option 2: Create a group of contacts, using the inputs in a CSV file

  • ContactsCsv - required

    A CSV string containing the information about the contacts to create.

    Required columns:

    ContactName

    A single string.

    The name of the contact.

    Example: John Doe

    ContactExternalEmailAddress

    A single string.

    The external email address of the contact.

    Example: johndoe@domain.com

Outputs:

  • AllErrorMessages

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

Version: 1.0.5

Date: 18 June 2019

Back to top


Create Distribution Groups

Creates Office 365 distribution groups

Inputs:

Usage option 1: Create a distribution group via a list of properties

  • Office365AdministrativeCredentials - required

    A MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Name - required

    A single string.

    The name for the distribution group.

  • EmailAddress - required

    A single string.

    The email address to be associated with the distribution group.

  • DisplayName - optional

    A single string.

    The display name for the distribution group.

  • MailNickname - optional

    A single string.

    The mail nickname for the distribution group.

Usage option 2: Create distribution groups via csv

  • Office365AdministrativeCredentials - required

    A MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • DistributionGroupsCsv - required

    A CSV string containing information about the distribution groups which will be created.

    Required columns:

    EmailAddress

    A single string.

    The email address for the distribution group.

    Name

    A single string.

    The name for the distribution group.

    Optional columns:

    MailNickname

    A single string.

    The mail nickname for the distribution group.

    DisplayName

    A single string.

    The display name for the distribution group.

Outputs:

  • Office365CreateDistributionGroupsCsv

    A CSV containing all the distribution groups which were processed by this task

    The additional column 'CreateDistributionGroupsOperationApplied' indicates if the action to create the group was successfully executed by this task.

    The additional column 'CreateDistributionGroupsStateAchieved' indicates if the desired state was achieved.

    The additional column 'CreateDistributionGroupsMessages' contains the warning/error messages which were generated during the course of the task.

  • Office365CreateDistributionGroupsErrorMessages

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

Version: 1.1.0

Date: 15 May 2019

Back to top


Create Domain Blacklist Mail Flow Rules

Creates mail flow rules to blacklist incoming mail from one or more domains

Inputs:

Usage option 1: Blacklist incoming mail from one or more domains in a single mail flow rule

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Domains - required

    One or more strings separated by a newline.

    This specifies the domains from which incoming mail will be blocked.

  • RuleName - optional

    A single string.

    This specifies the name of the mail flow rule which is created to blacklist incoming mail from the domain.

    If this is not provided, it will default to 'Blacklist incoming mail from x,y,z' (where x, y and z are the domains provided).

    This has a maximum length of 64 characters and will be truncated if the provided name is longer than 64 characters.

  • MailRejectionMessage - optional

    A single string.

    This specifies the message which is sent to the sender when their mail is rejected by this rule.

    If this is not provided, any mail rejected by this rule will be deleted silently.

Usage option 2: Blacklist incoming mail from one or more domains in separate mail flow rules

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • MailFlowRulesCsv - required

    A CSV string containing information about the mail flow rules to be created.

    Required columns:

    Domains

    One or more strings separated by a comma, enclosed in double quotes.

    This specifies the domains from which incoming mail will be blocked.

    Optional columns:

    RuleName

    A single string.

    This specifies the name of the mail flow rule which is created to blacklist incoming mail from the domains.

    If this is not provided, it will default to 'Blacklist incoming mail from x,y,z' (where x, y and z are the domains provided).

    This has a maximum length of 64 characters and will be truncated if the provided name is longer than 64 characters.

    MailRejectionMessage

    A single string.

    This specifies the message which is sent to the sender when their mail is rejected by this rule.

    If this is not provided, any mail rejected by this rule will be deleted silently.

Outputs:

  • Office365CreateDomainBlacklistMailFlowRulesCsv

    A CSV string containing information about the mail flow rules to be created, as well as an additional column 'CreatedRule' to indicate if the mail flow rule was successfully created.

  • Office365CreateDomainBlacklistMailFlowRulesErrorMessages

    A string containing the error messages generated over the course of the task.

Version: 1.0.1

Date: 18 June 2019

Back to top


Create Public Folder Mailboxes

Before a Public Folder can be created, at least 1 Public Folder Mailbox must be created.

The task library component creates Public Folder Mailboxes from a list of mailbox names, using the New-Mailbox cmdlet.

Public Folder Mailboxes are specially designed mailboxes that store the hierarchy and content of Public Folders.

The first Public Folder Mailbox created in your Exchange organization is called the primary hierarchy mailbox.

It contains the writeable copy of the hierarchy of Public Folders for the organization and Public Folder content.

There can be only one writeable copy of the Public Folder hierarchy in your organization.

All other Public Folder Mailboxes are called secondary Public Folder Mailboxes and contain a read-only copy of the hierarchy and the content for Public Folders.

Inputs:

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • PublicFolderMailboxNames - required

    One or more strings separated by a new line.

    A list of Public Folder Mailbox names separated by newline. Example:

    Primary Hierarchy Mailbox

    Secondary Hierarchy Mailbox 01

    Secondary Hierarchy Mailbox 02

    Secondary Hierarchy Mailbox 03

Outputs:

  • Office365CreatePublicFolderMailboxesErrorMessages

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

Version: 1.1.1

Date: 18 June 2019

Back to top


Create Public Folders

The task library component creates a Public Folder with the provided name and path.

It also creates a group of Public Folders from the inputs in a CSV file

Inputs:

Usage option 1: Create a Public Folder

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • PublicFolderName - required

    A single string.

    The name of the Public Folder.

    Example: Marketing.

  • PublicFolderMailbox - optional

    A single string.

    The identity of the hierarchy public folder mailbox.

    Example: Primary Hierarchy Mailbox.

  • PublicFolderPath - optional

    A single string.

    The path of the Public Folder.

    The path must start with a \.

    Example: \Marketing.

Usage option 2: Create a group of Public Folders, using the inputs from a CSV file

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • PublicFoldersCsv - required

    Required columns:

    PublicFolderName

    A string representing the name of the Public Folder.

    Example: Marketing

    Optional columns:

    PublicFolderMailbox

    A string representing the identity of the hierarchy public folder mailbox.

    Example: Primary Hierarchy Mailbox

    PublicFolderPath

    A string representing the path of the Public Folder.

    The path must start with a \.

    Example: \Marketing

Outputs:

  • Office365CreatePublicFoldersAllErrorMessages

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

Version: 1.0.4

Date: 18 June 2019

Back to top


Create Resource Mailboxes

Creates Office 365 Resource Mailboxes

Inputs:

Usage option 1: Create a resource mailbox

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Name - required

    A single string.

    The name for the resource mailbox.

  • Alias - required

    A single string.

    The portion of the resource mailbox email address before the @ symbol.

  • Type - required

    A single string.

    The Resource Mailbox Type.

    Valid values are 'Room' and 'Equipment' (case-insensitive).

  • DisplayName - optional

    A single string.

    The display name for the resource mailbox.

  • Capacity - optional

    A single string.

    The capacity of the resource mailbox.

  • Location - optional

    A single string.

    The physical location of the room or equipment.

Usage option 2: Create resource mailboxes via csv

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • ResourceMailboxesCsv - required

    A CSV string containing the information about the resource mailboxes to create.

    Required columns:

    Name

    A single string.

    The name for the resource mailbox.

    Alias

    A single string.

    The portion of the resource mailbox email address before the @ symbol.

    Type

    A single string.

    The Resource Mailbox Type.

    Valid values are 'room' and 'equipment' (case-insensitive).

    Optional columns:

    DisplayName

    A single string.

    The display name for the resource mailbox.

    Capacity

    A single string.

    The capacity of the resource mailbox.

    Location

    A single string.

    The physical location of the room or equipment.

Outputs:

  • Office365CreateResourceMailboxesCsv

    A CSV containing all the mailboxes which were processed by this task, as well as an additional column 'CreatedResourceMailbox' to indicate if the mailboxes were created successfully.

  • Office365CreateResourceMailboxesErrorMessages

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

Version: 1.0.2

Date: 18 June 2019

Back to top


Create Security Groups

Creates Office 365 security groups

Inputs:

Usage option 1: Create a security group via a list of properties

  • Office365AdministrativeCredentials - required

    A MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Name - required

    A single string.

    The name for the security group.

  • EmailAddress - required

    A single string.

    The email address to be associated with the security group.

  • DisplayName - optional

    A single string.

    The display name for the security group.

  • MailNickname - optional

    A single string.

    The mail nickname for the security group.

Usage option 2: Create security groups via csv

  • Office365AdministrativeCredentials - required

    A MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • SecurityGroupsCsv - required

    A CSV string containing information about the security groups which will be created.

    Required columns:

    EmailAddress

    A single string.

    The email address for the security group.

    Name

    A single string.

    The name for the security group.

    Optional columns:

    MailNickname

    A single string.

    The mail nickname for the security group.

    DisplayName

    A single string.

    The display name for the security group.

Outputs:

  • Office365CreateSecurityGroupsCsv

    A CSV containing all the security groups which were processed by this task, as well as an additional column 'CreatedSecurityGroup' to indicate if the security groups were created successfully.

  • Office365CreateSecurityGroupsErrorMessages

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

Version: 1.0.1

Date: 18 June 2019

Back to top


Create Shared Mailboxes

Creates Office 365 Shared Mailboxes

Inputs:

Usage option 1: Create a shared mailbox via a list of properties

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Name - required

    A single string.

    The name for the shared mailbox.

  • Alias - required

    A single string.

    The portion of the shared mailbox email address before the @ symbol.

Usage option 2: Create shared mailboxes via CSV

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • SharedMailboxesCsv - required

    A CSV string containing the information about the shared mailboxes to create.

    Required columns:

    Name

    A single string.

    Name for the shared mailbox.

    Alias

    A single string.

    The portion of the shared mailbox email address before the @ symbol.

Outputs:

  • Office365CreateSharedMailboxesCsv

    A CSV containing all the mailboxes which were processed by this task, as well as an additional column 'CreatedSharedMailbox' to indicate if the mailboxes were created successfully.

  • Office365CreateSharedMailboxesErrorMessages

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

Version: 1.0.2

Date: 18 June 2019

Back to top


Create Unified Groups

Creates Office 365 unified groups

Inputs:

Usage option 1: Create a unified group via a list of properties

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Name - required

    A single string.

    The name for the unified group.

  • EmailAddress - required

    A single string.

    The email address to be associated with the unified group.

  • DisplayName - optional

    A single string.

    The display name for the unified group.

  • MailNickname - optional

    A single string.

    The mail nickname for the unified group.

Usage option 2: Create unified groups via csv

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UnifiedGroupsCsv - required

    A CSV string containing information about the unified groups which will be created.

    Required columns:

    EmailAddress

    A single string.

    The email address for the unified group.

    Name

    A single string.

    The name for the unified group.

    Optional columns:

    MailNickname

    A single string.

    The mail nickname for the unified group.

    DisplayName

    A single string.

    The display name for the unified group.

Outputs:

  • Office365CreateUnifiedGroupsCsv

    A CSV containing all the unified groups which were processed by this task, as well as an additional column 'CreatedUnifiedGroup' to indicate if the unified groups were created successfully.

  • Office365CreateUnifiedGroupsErrorMessages

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

Version: 1.0.1

Date: 18 June 2019

Back to top


Create Users

Creates an Office 365 user or multiple users via a CSV string

Inputs:

Usage option 1: Create one Office 365 user from a list of properties

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • FirstName - conditionally required

    A single string.

    The first name of the new user.

    Either FirstName, LastName or DisplayName must be supplied.

  • LastName - conditionally required

    A single string.

    The last name of the new user.

    Either FirstName, LastName or DisplayName must be supplied.

  • DisplayName - conditionally required

    A single string.

    The display name of the new user.

    Either FirstName, LastName or DisplayName must be supplied.

  • UserPrincipalName - required

    A single string.

    The user principal name of new user.

  • MobilePhoneNumber - optional

    A single string.

    The mobile phone number of new user.

  • TelephoneNumber - optional

    A single string.

    The telephone number of new user.

  • AddressLine1 - optional

    A single string.

    The address line 1 of new user.

  • City - optional

    A single string.

    The city of new user.

  • StateOrProvince - optional

    A single string.

    The state or province of new user.

  • PostalOrZipCode - optional

    A single string.

    The postal or zip code of new user.

  • CountryOrRegion - optional

    A single string.

    The country or region of new user.

  • Department - optional

    A single string.

    The department of new user.

  • JobTitle - optional

    A single string.

    The job title of new user.

  • Password - optional

    A single string.

    The password for user's account. If a Password is not provided, one is randomly generated.

  • ForcePasswordChangeOnNextLogin - optional

    A single boolean variable.

    Specifies if the user is forced to change their password upon next login.

    Defaults to true.

  • UsageLocation - optional

    A single string.

    The usage location code for user's account. This is required to be set is licenses are to be assigned to the user.

Usage option 2: Create Office 365 users from a csv string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UsersInformationCsv - required

    A CSV string containing information about the users to be created.

    Required columns:

    UserPrincipalName

    A single string.

    User principal name of new user

    Optional columns:

    FirstName

    A single string.

    The first name of the new user.

    Either FirstName, LastName or DisplayName must be supplied.

    LastName

    A single string.

    The last name of the new user.

    Either FirstName, LastName or DisplayName must be supplied.

    DisplayName

    A single string.

    The display name of the new user.

    Either FirstName, LastName or DisplayName must be supplied.

    MobilePhoneNumber

    A single string.

    The mobile phone number of new user.

    TelephoneNumber

    A single string.

    The telephone number of new user.

    AddressLine1

    A single string.

    The address line 1 of new user.

    City

    A single string.

    The city of new user

    StateOrProvince

    A single string.

    The state or province of new user.

    PostalOrZipCode

    A single string.

    The postal or zip code of new user.

    CountryOrRegion

    A single string.

    The country or region of new user.

    Department

    A single string.

    The department of new user.

    JobTitle

    A single string.

    The job title of new user.

    Password

    A single string.

    The password for user's account. If a Password is not provided, one is randomly generated.

    ForcePasswordChangeOnNextLogin

    Boolean, optional

    Specifies if the user is forced to change their password upon next login.

    Defaults to true.

    UsageLocation

    A single string.

    The usage location code for user's account. This is required to be set is licenses are to be assigned to the user.

Outputs:

  • Password

    The generated password when running the task for a single user

  • Office365CreateUsersCsv

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

    If the user already exists it will be indicated by a value in the column 'PreviouslyPresent'

  • Office365CreateUsersErrorMessages

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

Version: 1.1.4

Date: 18 June 2019

Back to top


Delete Contacts

Deletes Office 365 contacts

Inputs:

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • ContactIdentities - required

    One or more strings separated by a new line.

    The names of the contacts to delete.

Outputs:

  • AllErrorMessages

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

Version: 1.0.3

Date: 18 June 2019

Back to top


Delete Distribution Groups

Deletes Office 365 distribution groups

Inputs:

Usage option 1: Delete Office 365 distribution groups via MSPComplete group objects

  • Office365AdministrativeCredentials - required

    A MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Groups - required

    One or more MSPComplete group objects.

    The distribution groups to delete.

Usage option 2: Delete Office 365 distribution groups via csv

  • Office365AdministrativeCredentials - required

    A MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • DistributionGroupsCsv - required

    A CSV string containing email addresses of the distribution groups which will be deleted.

    Required columns:

    PrimaryEmailAddress

    A single string.

    The email address for the distribution group.

Outputs:

  • Office365DeleteDistributionGroupsCsv

    A CSV containing all the distribution groups which were processed by this task

    The additional column 'DeleteDistributionGroupsOperationApplied' indicates if the action to delete the group was successfully executed by this task.

    The additional column 'DeleteDistributionGroupsStateAchieved' indicates if the desired state was achieved.

    The additional column 'DeleteDistributionGroupsMessages' contains the warning/error messages which were generated during the course of the task.

  • Office365DeleteDistributionGroupsErrorMessages

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

Version: 1.1.0

Date: 15 May 2019

Back to top


Delete Public Folder Mailboxes

The task library component deletes Public Folder Mailboxes from a list of mailbox names, using the Remove-Mailbox cmdlet.

Public Folder Mailboxes are specially designed mailboxes that store the hierarchy and content of Public Folders.

At least 1 Public Folder Mailbox must be present in the organization, before a Public Folder can be created.

Inputs:

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • PublicFolderMailboxNames - required

    One or more strings separated by a new line.

    A list of Public Folder Mailbox names separated by newline. Example:

    Secondary Hierarchy Mailbox 01

    Secondary Hierarchy Mailbox 02

    Secondary Hierarchy Mailbox 03

Outputs:

  • Office365DeletePublicFolderMailboxesErrorMessages

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

Version: 1.1.1

Date: 18 June 2019

Back to top


Delete Public Folders

The task library component deletes public folders from an input list of identities.

An identity is the full path of the public folder, e.g. "\Test\Directory\My Public Folder".

To prevent the accidental removal of sub-folders, all sub-folders must be specified in the identity list before the parent folder.

Inputs:

Usage option 1: Delete a list of Public Folders

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • PublicFolderIdentities - required

    One or more strings separated by a new line.

    Example:

    \Test\Directory\My Public Folder 1\Folder 1-1

    \Test\Directory\My Public Folder 1\Folder 1-2

    \Test\Directory\My Public Folder 1

    \Test\Directory\My Public Folder 2

    \Test\Directory\My Public Folder 3

Outputs:

  • Office365DeletePublicFoldersAllErrorMessages

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

Version: 1.0.3

Date: 18 June 2019

Back to top


Delete Resource Mailboxes

Deletes Office 365 Resource Mailboxes

Inputs:

Usage option 1: Deletes Office 365 Resource Mailboxes via a list of email addresses

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • ResourceMailboxes - required

    One or more MSPComplete end user objects.

    The resource mailboxes to delete.

Usage option 2: Deletes Office 365 Resource Mailboxes via csv

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • ResourceMailboxesCsv - required

    A CSV string containing email addresses of the resource mailboxes which will be deleted.

    Required columns:

    PrimaryEmailAddress

    A single string.

    The email address for the resource mailbox.

Outputs:

  • Office365DeleteResourceMailboxesCsv

    A CSV containing all the resource mailboxes which were processed by this task, as well as an additional column 'DeletedResourceMailbox' to indicate if the resource mailboxes were deleted successfully.

  • Office365DeleteResourceMailboxesErrorMessages

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

Version: 1.0.2

Date: 18 June 2019

Back to top


Delete Shared Mailboxes

Deletes Office 365 Shared Mailboxes

Inputs:

Usage option 1: Deletes Office 365 Shared Mailboxes via a list of email addresses

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • SharedMailboxes - required

    One or more MSPComplete end user objects.

    The shared mailboxes to delete.

Usage option 2: Deletes Office 365 Shared Mailboxes via csv

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • SharedMailboxesCsv - required

    A CSV string containing email addresses of the shared mailboxes which will be deleted.

    Required columns:

    PrimaryEmailAddress

    A single string.

    The email address for the shared mailbox.

Outputs:

  • Office365DeleteSharedMailboxesCsv

    A CSV containing all the shared mailboxes which were processed by this task, as well as an additional column 'DeletedSharedMailbox' to indicate if the shared mailboxes were deleted successfully.

  • Office365DeleteSharedMailboxesErrorMessages

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

Version: 1.0.1

Date: 18 June 2019

Back to top


Delete Unified Groups

Deletes Office 365 unified groups

Inputs:

Usage option 1: Delete Office 365 unified groups via MSPComplete group objects

  • Office365AdministrativeCredentials - required

    A MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Groups - required

    One or more MSPComplete group objects.

    The unified groups to delete.

Usage option 2: Delete Office 365 unified groups via csv

  • Office365AdministrativeCredentials - required

    A MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UnifiedGroupsCsv - required

    A CSV string containing email addresses of the unified groups which will be deleted.

    Required columns:

    PrimaryEmailAddress

    A single string.

    The email address for the unified group.

Outputs:

  • Office365DeleteUnifiedGroupsCsv

    A CSV containing all the unified groups which were processed by this task, as well as an additional column 'DeletedUnifiedGroup' to indicate if the unified groups were deleted successfully.

  • Office365DeleteUnifiedGroupsErrorMessages

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

Version: 1.0.0

Date: 26 April 2019

Back to top


Enable/Disable Litigation Hold on Mailboxes

Enables or disables litigation hold on Office 365 mailboxes, as well as setting the period that the litigation hold will be in effect

Inputs:

Usage option 1: Enable or disable litigation hold on one or more mailboxes

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Users - required

    One or more MSPComplete end user objects.

    The users to enable or disable litigation hold on

  • EnableOrDisableLitigationHold - required

    A single string.

    Valid values are 'enable' and 'disable' (case-insensitive).

  • LitigationHoldDuration - optional

    A single string.

    This is the number of days the mailbox will be held in litigation hold.

    Valid values are whole numbers greater than 0.

    If no value is provided, this will set the mailbox on litigation hold indefinitely.

Usage option 2: Enable or disable litigation hold on one or more mailboxes via CSV

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • LitigationHoldCsv - required

    A CSV string containing information about the users to enable/disable litigation hold on

    Required columns:

    UserPrincipalName

    A single string.

    The email address of the user.

    EnableOrDisableLitigationHold

    A single string.

    Valid values are 'enable' and 'disable' (case-insensitive).

    LitigationHoldDuration

    A single string

    This is the number of days the mailbox will be held in litigation hold.

    Valid values are whole numbers greater than 0.

    If no value is provided, this will set the mailbox on litigation hold indefinitely.

Outputs:

  • Office365EnableDisableLitigationHoldOnMailboxesCsv

    A CSV containing all the user mailboxes which were processed by this task, as well as an additional column 'LitigationHoldUpdated' to indicate if the update of litigation hold is successful.

  • Office365EnableDisableLitigationHoldOnMailboxesErrorMessages

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

Version: 1.1.1

Date: 18 June 2019

Back to top


Enable/Disable Multi-Factor Authentication for Users

Enables or disables multi-factor authentication for Office 365 users.

Inputs:

Usage option 1: Enable or disable multi-factor authentication for a single user

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • User - required

    A single MSPComplete end user object.

    The user to enable or disable multi-factor authentication.

  • EnableDisableMfa - required

    A single string.

    Valid values are "enable" and "disable" (case-insensitive).

  • RememberDevicesNotIssuedBefore - optional

    Single string, optional

    This is a cutoff date, where any devices issued to the user before this date will

    require MFA setup.

    This input is only relevant when enabling MFA.

    If not provided, the default will be the current date, i.e. all devices issued to the

    user will require MFA setup.

    Valid date formats are "day month year", where month can be either the long or short

    month name (Dec or December), and year can either be the 2 or 4 digit year (10 or 2010,

    95 or 1995)

Usage option 2: Enable or disable multi-factor authentication for multiple users via CSV

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UsersCsv - required

    Required columns:

    PrimaryEmailAddress

    EnableDisableMfa

    Optional columns:

    RememberDevicesNotIssuedBefore

Outputs:

  • Office365EnableDisableMultiFactorAuthenticationForUsersCsv

    A CSV string containing the information about the users for which MFA was enabled/disabled,

    as well as an additional column 'MfaUpdated' to indicate if MFA was successfully enabled or disabled.

  • Office365EnableDisableMultiFactorAuthenticationForUsersErrorMessages

    A string containing all the errors messages which were generated over the course of this task.

Version: 1.0.2

Date: 18 June 2019

Back to top


Force User to Sign Out

Forces a user to sign out of any Office 365 applications and webpages by revoking all refresh tokens

Inputs:

Usage option 1: Signs out a user from Office 365

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • User - required

    A single MSPComplete end user object.

    The user to force sign-out.

Outputs:

  • None

Version: 1.0.1

Date: 18 June 2019

Back to top


Grant Mailbox Permission

Grant Mailbox Permission for a user

Inputs:

Usage option 1: Grant permission on a mailbox for the specified user

  • Office365Endpoint

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

    The credentials for the tenant to complete the operation on

  • GranteeUser

    A MSPComplete user object, required.

    The user we are granting access

  • GrantorUser

    A MSPComplete user object, required.

    The mailbox we are adding permission for

  • AccessType

    The type of access to grant. Valid values are 'FullAccess' (default), 'ReadPermission', 'ChangeOwner', 'ChangePermission', 'DeleteItem', and 'ExternalAccount'

Outputs:

  • None

Version: 1.1

Date: 29 August 2018

Back to top


Grant Public Folder Permissions

Grant Public Folder Permissions to users.

The users would be able to read, create, edit and delete items in the public folders, if they have the required permissions.

The permissions include:

ReadItems: The user has the right to read items within the specified public folder.

CreateItems: The user has the right to create items within the specified public folder.

EditOwnedItems: The user has the right to edit the items that the user owns in the specified public folder.

DeleteOwnedItems: The user has the right to delete items that the user owns in the specified public folder.

EditAllItems: The user has the right to edit all items in the specified public folder.

DeleteAllItems: The user has the right to delete all items in the specified public folder.

CreateSubfolders: The user has the right to create subfolders in the specified public folder.

FolderOwner: The user is the owner of the specified public folder. The user has the right to view and move the public folder and create subfolders. The user can't read items, edit items, delete items, or create items.

FolderContact: The user is the contact for the specified public folder.

FolderVisible: The user can view the specified public folder, but can't read or edit items within the specified public folder.

Permissions can be assigned based on the following roles:

None: FolderVisible

Owner: CreateItems, ReadItems, CreateSubfolders, FolderOwner, FolderContact, FolderVisible, EditOwnedItems, EditAllItems, DeleteOwnedItems, DeleteAllItems

PublishingEditor: CreateItems, ReadItems, CreateSubfolders, FolderVisible, EditOwnedItems, EditAllItems, DeleteOwnedItems, DeleteAllItems

Editor: CreateItems, ReadItems, FolderVisible, EditOwnedItems, EditAllItems, DeleteOwnedItems, DeleteAllItems

PublishingAuthor: CreateItems, ReadItems, CreateSubfolders, FolderVisible, EditOwnedItems, DeleteOwnedItems

Author: CreateItems, ReadItems, FolderVisible, EditOwnedItems, DeleteOwnedItems

NonEditingAuthor: CreateItems, ReadItems, FolderVisible

Reviewer: ReadItems, FolderVisible

Contributor: CreateItems, FolderVisible

Inputs:

Usage option 1: Granting permissions for 1 user in 1 Public Folder

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • PublicFolderIdentity - required

    A single string.

    The full path or name of the Public Folder.

    Example: \Test\Directory\My Public Folder 1.

    Example: Public Folder 1.

  • User - required

    Single MSPComplete end user that corresponds to the Office 365 user to grant the permissions.

    If more than one object is provided, only the first one is used.

  • PublicFolderAccessRights - required

    One or more strings separated by a new line.

    This specifies the right(s) granted to the user.

    Example (Single Permission): ReadItems

    Example (Multiple Permissions): ReadItems

    CreateItems

    DeleteOwnedItems

    EditOwnedItems

    Example (Single Role): Owner

    Example (Multiple Roles): Reviewer

    Contributor

Usage option 2: Granting permissions for multiple users in Public Folders, using the inputs from a CSV file

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • PublicFoldersCsv - required

    Required columns:

    PublicFolderIdentity

    A string representing the full path or name of the Public Folder.

    User

    The primary email address of the Office 365 user to grant the permissions.

    PublicFolderAccessRights

    A comma-delimited string representing the rights added to the user.

Outputs:

  • Office365GrantPublicFolderPermissionsCsv

    A CSV containing all the public folders which were processed by this task, as well as an additional column 'PublicFolderPermissionsGranted' to indicate if the permissions were granted successfully.

  • Office365GrantPublicFolderPermissionsAllErrorMessages

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

Version: 1.1.3

Date: 18 June 2019

Back to top


Grant/Remove Calendar Permissions

Grants or removes calendar permissions to Office 365 users.

The types of calendar permissions which can be granted/removed are:

CreateItems: The user can create items within the specified calendar.

CreateSubfolders: The user can create subfolders in the specified calendar.

DeleteAllItems: The user can delete all items in the specified calendar.

DeleteOwnedItems: The user can only delete items that they created from the specified calendar.

EditAllItems: The user can edit all items in the specified calendar.

EditOwnedItems: The user can only edit items that they created in the specified calendar.

FolderContact: The user is the contact for the specified public calendar.

FolderOwner: The user is the owner of the specified calendar. The user can view the calendar, move the calendar and create subfolders. The user can't read items, edit items, delete items or create items.

FolderVisible: The user can view the specified calendar, but can't read or edit items within the specified public calendar.

ReadItems: The user can read items within the specified calendar.

Author: Contains CreateItems, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems

Contributor: Contains CreateItems, FolderVisible

Editor: Contains CreateItems, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems

None: Contains FolderVisible

NonEditingAuthor: Contains CreateItems, FolderVisible, ReadItems

Owner: Contains CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderContact, FolderOwner, FolderVisible, ReadItems

PublishingEditor: Contains CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems

PublishingAuthor: Contains CreateItems, CreateSubfolders, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems

Reviewer: Contains FolderVisible, ReadItems

AvailabilityOnly: View only availability data

LimitedDetails: View availability data with subject and location

Inputs:

Usage option 1: Grants or removes a set of permissions to access one or more calendars, for one or more users

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • CalendarIdentities - required

    One or more strings separated by a new line.

    The identity for the calendars.

    The calendar identity is in the form of USER_PRINCIPAL_NAME:\CALENDAR_NAME (example john.doe@mydomain.com:\Calendar)

  • Users - required

    One or more end user objects.

    The users which will receive/lose the calendar permission.

  • AccessRights - required

    One or more strings separated by a new line.

    Specifies the type of permissions to grant or remove.

    Valid values are 'CreateItems', 'CreateSubfolders', 'DeleteAllItems', 'DeleteOwnedItems', 'FolderContact', 'FolderOwner', 'FolderVisible', 'ReadItems', 'Author', 'Contributor', 'Editor', 'None', 'NonEditingAuthor', 'Owner', 'PublishingEditor', 'PublishingAuthor', 'Reviewer', 'AvailabilityOnly', 'LimitedDetails' (case insensitive).

  • GrantOrRemovePermissions - required

    A single string.

    Specifies if the permission will be granted or removed.

    Valid values are 'Grant' and 'Remove' (case insensitive).

Usage option 2: Grants or removes calendar permissions for users using a CSV string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • CalendarPermissionsCsv - required

    A CSV string containing information about the calendars, users and permissions which will be granted/removed.

    Required columns:

    CalendarIdentity

    A single string.

    The identity for the calendar.

    The calendar identity is in the form of USER_PRINCIPAL_NAME:\CALENDAR_NAME (example john.doe@mydomain.com:\Calendar)

    UserPrimaryEmailAddress

    A single string.

    The primary email address of the user which will receive/lose the calendar permission.

    AccessRight

    A single string.

    Specifies the type of permission to grant or remove.

    Valid values are 'CreateItems', 'CreateSubfolders', 'DeleteAllItems', 'DeleteOwnedItems', 'FolderContact', 'FolderOwner', 'FolderVisible', 'ReadItems', 'Author', 'Contributor', 'Editor', 'None', 'NonEditingAuthor', 'Owner', 'PublishingEditor', 'PublishingAuthor', 'Reviewer', 'AvailabilityOnly', 'LimitedDetails' (case insensitive).

    GrantOrRemovePermission

    A single string.

    Specifies if the permission will be granted or removed from the users.

    Valid values are 'Grant' and 'Remove' (case insensitive).

Outputs:

  • Office365GrantRemoveCalendarPermissionsCsv

    A CSV string containing information about the calendars, users and permissions which were granted/removed.

    The column 'GrantRemoveCalendarPermissionsOperationApplied' indicates if this task granted or removed the permission.

    The column 'GrantRemoveCalendarPermissionsStateAchieved' indicates if the permissions to grant were present by the end of the task, and if the permissions to remove were not present by the end of the task.

    The column 'GrantRemoveCalendarPermissionsMessages' contains the warning and/or error messages which were generated while granting or removing the calendar permissions.

  • Office365GrantRemoveCalendarPermissionsErrorMessages

    A string containing the error messages which were generated over the course of the task.

Version: 1.1.0

Date: 13 June 2019

Back to top


Grant/Remove Full Access Permissions

Grants or removes 'Full Access' Permission to mailboxes

Inputs:

Usage option 1: Grant or remove one user's 'Full Access' Permission to multiple mailboxes

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • GranteeUsers - required

    Single MSPComplete end user object.

    The mailbox that will be granted or removed the permission.

  • GrantorUsers - required

    Multiple MSPComplete end user objects.

    The mailboxes that will granting or removing the permission.

  • GrantOrRemovePermission - required

    A single string.

    Valid values are 'grant' and 'remove' (case-insensitive).

Usage option 2: Grant or remove multiple users' 'Full Access' Permission to one mailbox

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • GranteeUsers - required

    Multiple MSPComplete end user objects.

    The mailboxes that will be granted or removed the permission.

  • GrantorUsers - required

    Single MSPComplete end user object.

    The mailbox that will granting or removing the permission. If more than one object is provided, only the first one is used.

  • GrantOrRemovePermission - required

    A single string.

    Valid values are 'grant' and 'remove' (case-insensitive).

Usage option 3: Grant or remove 'Full Access' Permissions via CSV

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • FullAccessPermissionsCsv

    Required columns:

    • GranteeEmailAddress

      The email address of the grantee.

    • GrantOrRemovePermission

      Valid values are 'grant' and 'remove' (case-insensitive).

    • GrantorEmailAddress

      The email address of the grantor.

Outputs:

  • Office365GrantRemoveFullAccessPermissionsCsv

    A CSV containing all the users which were processed by this task.

    The additional column 'GrantRemoveFullAccessPermissionsOperationApplied' indicates if the action to grant or remove full access permission was successfully executed by this task.

    The additional column 'GrantRemoveFullAccessPermissionsStateAchieved' indicates if the desired state was achieved.

    The additional column 'GrantRemoveFullAccessPermissionsMessages' contains the warning/error messages which were generated during the course of the task.

  • Office365GrantRemoveFullAccessPermissionsErrorMessages

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

Version: 1.2.0

Date: 10 May 2019

Back to top


Grant/Remove Send As Permissions

Grants or removes 'Send As' Permission to mailboxes, distribution groups or dynamic distribution groups

Inputs:

Usage option 1: Grant or remove one user's 'Send As' Permission to multiple mailboxes

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • GranteeUsers - required

    Single MSPComplete end user object.

    The mailbox that will be granted or removed the permission.

  • GrantorUsers - required

    Multiple MSPComplete end user objects.

    The mailboxes that will granting or removing the permission.

  • GrantOrRemovePermission - required

    A single string.

    Valid values are 'grant' and 'remove' (case-insensitive).

Usage option 2: Grant or remove multiple users' 'Send As' Permission to one mailbox

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • GranteeUsers - required

    Multiple MSPComplete end user objects.

    The mailboxes that will be granted or removed the permission.

  • GrantorUsers - required

    Single MSPComplete end user object.

    The mailbox that will be granting or removing the permission. If more than one object is provided, only the first one is used.

  • GrantOrRemovePermission - required

    A single string.

    Valid values are 'grant' and 'remove' (case-insensitive).

Usage option 3: Grant or remove one user's 'Send As' Permission to multiple groups

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • GranteeUsers - required

    Single MSPComplete end user object.

    The mailbox that will be granted or removed the permission.

  • GrantorGroups - required

    Multiple MSPComplete group objects.

    The groups that will be granting or removing the permission.

  • GrantOrRemovePermission - required

    A single string.

    Valid values are 'grant' and 'remove' (case-insensitive).

Usage option 4: Grant or remove multiple user's 'Send As' Permission to one groups

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • GranteeUsers - required

    Multiple MSPComplete end user objects.

    The mailboxes that wil be granted or removed the permission.

  • GrantorGroups - required

    Single MSPComplete group object.

    The group that will be granting or removing the permission. If more than one object is provided, only the first one is used.

  • GrantOrRemovePermission - required

    A single string.

    Valid values are 'grant' and 'remove' (case-insensitive).

Usage option 5: Grant or remove 'Send As' Permissions via CSV

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • SendAsPermissionsCsv

    Required columns:

    • GranteeEmailAddress

      The email address of the grantee.

    • GrantOrRemovePermission

      Valid values are 'grant' and 'remove' (case-insensitive).

    • GrantorEmailAddress

      The email address of the grantor.

Outputs:

  • Office365GrantRemoveSendAsPermissionsCsv

    A CSV containing all the users and groups which were processed by this task.

    The additional column 'GrantRemoveSendAsPermissionsOperationApplied' indicates if the action to grant or remove permission was successfully executed by this task.

    The additional column 'GrantRemoveSendAsPermissionsStateAchieved' indicates if the desired state was achieved.

    The additional column 'GrantRemoveSendAsPermissionsMessages' contains the warning/error messages which were generated during the course of the task.

  • Office365GrantRemoveSendAsPermissionsErrorMessages

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

Version: 1.1.0

Date: 9 May 2019

Back to top


Grant/Remove Send On Behalf Permissions

Grants or removes 'Send On Behalf' Permission for mailboxes, distribution groups to mailboxes, distribution groups or dynamic distribution groups

Inputs:

Usage option 1: Grant or remove one (user or group)'s 'Send On Behalf' Permission to multiple (user and group) mailboxes

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • GranteeUsers - required

    Single MSPComplete end user object.

    The mailbox that will be granted or removed the permission.

  • GranteeGroups - required

    Single MSPComplete group object.

    The group that will be granted or removed the permission.

  • GrantorUsers - required

    Multiple MSPComplete end user objects.

    The mailboxes that will granting or removing the permission.

  • GrantorGroups - required

    Multiple MSPComplete group objects.

    The groups that will granting or removing the permission.

  • GrantOrRemovePermission - required

    A single string.

    Valid values are 'grant' and 'remove' (case-insensitive).

Usage option 2: Grant or remove multiple (user and group)s' 'Send On Behalf' Permission to one (user or group) mailbox

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • GranteeUsers - required

    Multiple MSPComplete end user objects.

    The mailboxes that will be granted or removed the permission.

  • GranteeGroups - required

    Multiple MSPComplete group objects.

    The groups that will be granted or removed the permission.

  • GrantorUsers - required

    Single MSPComplete end user object.

    The mailbox that will granting or removing the permission. If more than one object is provided, only the first one is used.

  • GrantorGroups - required

    Single MSPComplete group object.

    The group that will granting or removing the permission. If more than one object is provided, only the first one is used.

  • GrantOrRemovePermission - required

    A single string.

    Valid values are 'grant' and 'remove' (case-insensitive).

Usage option 3: Grant or remove 'Send On Behalf' Permissions via CSV

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the mailboxes.

  • SendOnBehalfOfPermissionsCsv

    Required columns:

    • GranteeEmailAddress

      The email address of the grantee.

    • GrantOrRemovePermission

      Valid values are 'grant' and 'remove' (case-insensitive).

    • GrantorEmailAddress

      The email address of the grantor.

Outputs:

  • Office365GrantRemoveSendOnBehalfPermissionsCsv

    A CSV containing all the users and groups which were processed by this task.

    The additional column 'GrantRemoveSendOnBehalfPermissionsOperationApplied' indicates if the action to grant or remove permission was successfully executed by this task.

    The additional column 'GrantRemoveSendOnBehalfPermissionsStateAchieved' indicates if the desired state was achieved.

    The additional column 'GrantRemoveSendOnBehalfPermissionsMessages' contains the warning/error messages which were generated during the course of the task.

  • Office365GrantRemoveSendOnBehalfPermissionsErrorMessages

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

Version: 1.3.0

Date: 14 May 2019

Back to top


Import Groups into MSPComplete V2

Imports all groups from an Office 365 tenant into MSPComplete.

The types of groups imported into MSPComplete are:

-Distribution groups

-Unified groups

-Dynamic distribution groups

The member lists for distribution groups and unified groups are also imported into MSPComplete.

In order for the distribution group and unified group members to be imported, the members first have to be imported into MSPComplete as end users, using [Office 365] - Import Users into MSPComplete.

The groups will be imported into the customer in the MSPComplete context (i.e. the customer for which the runbook was launched).

Inputs:

  • Office365AdministrativeCredentials

    A MSPComplete endpoint containing the Office 365 administrative credentials, required.

    The credentials for the tenant to import groups from

  • CreateGroups

    A single boolean value, optional, defaults to true.

    Specifies whether a group should be created in MSPComplete if it does not exist in MSPComplete, but if it exists in Office 365.

  • UpdateGroups

    A single boolean value, optional, defaults to true.

    Specifies whether a group should be updated in MSPComplete to match the group in Office 365, if it exists in both MSPComplete and Office 365.

    Updating a group consists of both updating the group information as well as its membership.

  • DeleteGroups

    A single boolean value, optional, defaults to false.

    Specifies whether a group should be deleted from MSPComplete if it exists in MSPComplete, but not in Office 365.

Outputs:

  • Office365ImportGroupsIntoMSPCompleteErrorMessages

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

Version: 2.0.0

Date: 21 March 2019

Back to top


Import Users into MSPComplete V2

Imports all users from an Office 365 tenant into MSPComplete.

The users will be imported into the current MSPComplete customer in context.

Both licensed and unlicensed users are imported.

Inputs:

  • Office365AdministrativeCredentials

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

    The credentials for the tenant to import users from

  • CreateUsers

    A single boolean value, optional, defaults to true.

    Selects whether a user should be created in MSPComplete if it does not exist in MSPComplete,

    but if it exists in Office 365.

  • UpdateUsers

    A single boolean value, optional, defaults to true.

    Selects whether a user should be updated in MSPComplete to match the user in Office 365,

    if it exists in both MSPComplete and Office 365.

  • DeleteUsers

    A single boolean value, optional, defaults to false.

    Selects whether a users should be deleted from MSPComplete if it exists in MSPComplete, but

    not in Office 365.

Outputs:

  • Office365ImportUsersIntoMSPCompleteErrorMessages

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

Version: 2.2.1

Date: 10 April 2019

Back to top


Remove Licenses from Users

Removes licenses from one or more Office 365 users

Inputs:

Usage option 1: Remove licenses for a user

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the users.

  • User - required

    A single MSPComplete end user object.

    The user from which the licenses will be removed.

    If more than one object is provided, only the first one is used.

  • Licenses - optional

    One or more license SKU IDs or SKU part numbers separated by a new line.

    If not provided, all licenses will be removed from the user.

    Example license SKU ID: reseller-account:ENTERPRISEPREMIUM

    Example SKU part number: ENTERPRISEPREMIUM

Usage option 2: Remove licenses for users via a CSV

  • Office365AdministrativeCredentials - required.

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the users.

  • UserLicensesCsv - required

    A CSV string containing the information about the user licenses to remove.

    Required columns:

    PrimaryEmailAddress

    A single string.

    The primary email address of the Office 365 user.

    Optional columns:

    License

    A single string.

    The SKU ID or SKU part number of the license to remove from the user.

    If not provided, all licenses will be removed from the user.

Outputs:

  • ProcessedUserLicensesCsv

    A CSV containing all the users which were processed by this task, as well as an additional column 'RemovedLicenses' to indicate if the licenses were removed successfully.

  • AllErrorMessages

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

Version: 1.2.2

Date: 18 June 2019

Back to top


Remove Mailbox Permission

Remove Mailbox Permission for a user

Inputs:

Usage option 1: Remove permission on a mailbox for the specified user

  • Office365Endpoint

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

    The credentials for the tenant to complete the operation on

  • GranteeUser

    A MSPComplete user object, required.

    The user we are removing access

  • GrantorUser

    A MSPComplete user object, required.

    The mailbox we are removing permission on

Outputs:

  • None

Version: 1.1

Date: 29 August 2018

Back to top


Delete Unified Group

Remove Unified Group

Inputs:

Usage option 1: Remove Unified Group

  • Office365Endpoint

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

    The credentials for the tenant to complete the operation on

  • UnifiedGroup

    A MSPComplete group object, required.

    The group we are removing

Outputs:

  • None

Version: 1.2

Date: 8 November 2018

Back to top


Remove Users

Removes one or more users via a provided list of users or from information gvien in a CSV string

Inputs:

Usage option 1: Remove Users from provided list of users

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Users - required

    One or more MSPComplete end user objects.

    The users to remove from Office 365.

Usage option 2: Remove Users using a CSV

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UsersInformationCsv - required

    A CSV containing information about the users to remove.

    Required columns:

    UserPrincipalName

    The user principal name uniquely identifying an user.

Outputs:

  • Office365RemoveUsersUpdatedUsersInformationCsv

    A CSV string containing the information about which users were successfully removed via an additional column 'Removed'.

  • Office365RemoveUsersErrorMessages

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

Version: 1.1.2

Date: 18 June 2019

Back to top


Retrieve GDPR Settings

Retrieves the Office 365 GDPR related settings as a CSV string

Inputs:

Usage option 1: Retrieve Office 365 GDPR related settings as a CSV string

  • Office365AdministrativeCredentials

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

    The credentials for the tenant to retrieve information from

Outputs:

  • Office365GdprSettingsCsv

    A CSV string containing the Office 365 GDPR related settings

Version: 1.0.1

Date: 7 November 2018

Back to top


Retrieve License Assignments

Retrieve all of the Office 365 license assignments for all or a specific mailbox

Inputs:

Usage option 1: Retrieve Office 365 license assignments for all or a specific mailbox

  • Office365Credentials

  • Complete endpoint object containing the Office 365 administrative credentials, required.

  • redentials for the tenant to retrieve information from

  • User

    A MSPComplete user object, optional.

    The user to retrieve license assignment information for

Outputs:

  • CsvList

    A CSV string containing the license assignment information.

Version: 1.0

Date: 14 July 2018

Back to top


Retrieve Licenses

Retrieve all Office 365 licenses

Inputs:

Usage option 1: Retrieve all Office 365 licenses

  • Office365Credentials

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

  • redentials for the tenant to retrieve information from

Outputs:

  • CsvList

    A CSV string containing the license information.

Version: 1.0

Date: 12 July 2018

Back to top


Retrieve Mailbox Permissions

Retrieve the permissions set on all or a specific mailbox

Inputs:

  • Office365Credentials - required

    A single MSPComplete endpoint object.

    Contains the Office 365 administrative credentials for the tenant.

  • User - optional

    A single MSPComplete end user object.

    The user to retrieve mailbox permissions information.

    If this is not specified, mailbox permissions information will be retrieved for all users.

Outputs:

  • CsvList

    A CSV string containing the mailbox permissions information.

Version: 1.0.1

Date: 4 April 2019

Back to top


Retrieve Mailbox Statistics

Retrieves the statistics for an Office 365 mailbox as a CSV string

Inputs:

Usage option 1: Retrieve mailbox statistics for users

  • Office365AdministrativeCredentials

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

    The credentials for the tenant to complete the operation on

  • Users

    One or more MSPComplete end user objects, required

    One or more users to retrieve mailbox statistics on

Usage option 2: Retrieve mailbox statistics based on user identities

  • Office365AdministrativeCredentials

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

    The credentials for the tenant to complete the operation on

  • Identities

    String, required

    List of newline separated identities to retrieve mailbox statistics on

    Identities can be any value that uniquely identifies the mailbox.

    For example:

    Name

    Display name

    Alias

    Email address

    GUID

    User principal name (UPN)

Outputs:

  • Office365AssignLicensesToUsersCsv

    A CSV containing all the users which were processed by this task, as well as an additional column 'AssignedLicenses' to indicate if the licenses were assigned successfully.

  • Office365AssignLicensesToUsersErrorMessages

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

Version: 1.0.1

Date: 12 December 2018

Back to top


Retrieve Public Folder Statistics

Retrieves the statistics for an Office 365 public folder as a CSV string

Inputs:

Usage option 1: Retrieves statistics for Office 365 public folder

  • Office365AdministrativeCredentials

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

    The credentials for the tenant to complete the operation on

  • Identities

    One or more public folder identities separated by a newline, optional. If no values are provide, will retrieve statistics for all public folders associated with the tenant

    The GUIDs or public folder names

Outputs:

  • PublicFolderStatisticsCsv

    A CSV containing the public folders information

  • AllErrorMessages

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

Version: 1.0

Date: 19 December 2018

Back to top


Retrieve Send As Permissions

Retrieve the send-as permission set on all or a specific mailbox

Inputs:

  • Office365Credentials - required

    A single MSPComplete endpoint object.

    Contains the Office 365 administrative credentials for the tenant.

  • User - optional

    A single MSPComplete end user object.

    The user to retrieve send-as permissions information.

    If this is not specified, send-as permissions information will be retrieved for all users.

Outputs:

  • CsvList

    A CSV string containing the Send-As permissions information.

Version: 1.0.1

Date: 4 April 2019

Back to top


Retrieve Send On Behalf Permissions

Retrieve the send on behalf permission set on all or a specific mailbox

Inputs:

  • Office365Credentials - required

    A single MSPComplete endpoint object.

    Contains the Office 365 administrative credentials for the tenant.

  • User - optional

    A single MSPComplete end user object.

    The user to retrieve send on behalf permissions information.

    If this is not specified, send on behalf permissions information will be retrieved for all users.

Outputs:

  • CsvList

    A CSV string containing the Send On Behalf permissions information.

Version: 1.0.1

Date: 4 April 2019

Back to top


Retrieve Subscribed SKUs

Retrieves the organization's currently subscribed Office 365 SKUs as a CSV string

Inputs:

Usage option 1: Retrieve subscribed Office 365 SKUs

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

Outputs:

  • SubscribedSkusCsv

    A CSV containing the subscribed skus for the tenant.

Version: 1.0.1

Date: 18 June 2019

Back to top


Retrieve User Information

Retrieves Office 365 user information as a CSV string.

The information retrieved includes:

- First name

- Last name

- Display name

- Address

- City

- State or province

- Postal or zip code

- Country or region

- Mobile phone number

- Company name

- Department

- Job title

- License

- Usage location

- Primary email address

- User principal name

- Administrator role

- Multi-factor authentication status

Inputs:

Usage option 1: Retrieves Office 365 user information

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the users.

  • Users - optional

    One or more MSPComplete end user objects.

    If provided, user information will only be retrieved from Office 365 for these users.

    If not provided, user information will be retrieved from Office 365 for all users.

Outputs:

  • UserInformationCsv

    A CSV string containing the user information retrieved.

Version: 1.1.3

Date: 14 June 2019

Back to top


Send Email V3

Sends an email from an Office 365 mailbox with attachments

If the attachments are in text format (i.e. extension with txt, csv, log, bat, dat), no encoding

of the attachment contents is required.

Otherwise if the attachments are not in text format, the attachment file bytes are to be encoded

in Base64.

Inputs:

  • Office365EmailCredentials - required

    A MSPComplete endpoint object containing the Office 365 email credentials.

  • EmailToAddress - required

    One or more strings separated by a newline.

    These are the destination email addresses for the email.

  • EmailSubject - required

    A single string.

    This is the subject line of the email.

  • EmailBody - required

    A single string.

    This is the main content of the email.

  • EmailCcAddress - optional

    One or more strings separated by a newline.

    These are the email addresses which will receive carbon copies of the email.

  • EmailBccAddress - optional

    One or more strings separated by a newline.

    These are the email addresses which will receive blind carbon copies of the email.

  • Attachment1FileName - optional

    A single string, in the format of FILENAME.EXTENSION.

    Example: report.pdf

  • Attachment1FileContents - optional

    A single string.

    If the attachment is in text format, this should be the text contents of the attachment.

    If the attachment is in non-text format, this should be the Base64 encoded byte contents of the attachment file, using [Convert]::ToBase64String((Get-Content -Encoding Byte -Path FILE_PATH)).

  • Attachment(X)FileName - optional

    A single string.

    (X) is 2 to 10.

    Same as Attachment1FileName.

  • Attachment(X)FileContents - optional

    A single string.

    (X) is 2 to 10.

    Same as Attachment1FileContents.

Outputs:

  • None

Version: 3.0.0

Date: 24 June 2019

Back to top


Set Mailboxes' Quotas

Sets quotas for Office 365 mailboxes.

The quotas which can be set are:

- Prohibit send quota

- Prohibit send receive quota

- Issue warning quota

Inputs:

Usage option 1: Set a single set of quotas for one or more mailboxes

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Mailboxes - required

    One or more MSPComplete end user objects.

    The mailboxes which will receive the new quotas specified.

    All of the mailboxes will receive the same quotas.

  • ProhibitSendQuotaGigabytes - conditionally required

    A single string.

    The size limit in gigabytes for the mailbox where the user will not be able to send new messages upon reaching or exceeding this size.

    At least one of ProhibitSendQuotaGigabytes, ProhibitSendReceiveQuotaGigabytes or IssueWarningQuotaGigabytes must be provided.

  • ProhibitSendReceiveQuotaGigabytes - conditionally required

    A single string.

    The size limit in gigabytes for the mailbox where the user will not be able to send or receive new messages upon reaching or exceeding this size.

    At least one of ProhibitSendQuotaGigabytes, ProhibitSendReceiveQuotaGigabytes or IssueWarningQuotaGigabytes must be provided.

  • IssueWarningQuotaGigabytes - conditionally required

    A single string.

    The size limit in gigabytes for the mailbox where the user will receive a warning upon reaching or exceeding this size.

    At least one of ProhibitSendQuotaGigabytes, ProhibitSendReceiveQuotaGigabytes or IssueWarningQuotaGigabytes must be provided.

Usage option 2: Set quotas for mailboxes

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • MailboxesCsv - required

    A CSV string containing the information about the mailboxes and quotas to set.

    Required columns:

    PrimaryEmailAddress

    A single string.

    The primary email address of the mailbox.

    Optional columns:

    ProhibitSendQuotaGigabytes

    A single string.

    The size limit in gigabytes for the mailbox where the user will not be able to send new messages upon reaching or exceeding this size.

    At least one of ProhibitSendQuotaGigabytes, ProhibitSendReceiveQuotaGigabytes or IssueWarningQuotaGigabytes must be provided.

    ProhibitSendReceiveQuotaGigabytes

    A single string.

    The size limit in gigabytes for the mailbox where the user will not be able to send or receive new messages upon reaching or exceeding this size.

    At least one of ProhibitSendQuotaGigabytes, ProhibitSendReceiveQuotaGigabytes or IssueWarningQuotaGigabytes must be provided.

    IssueWarningQuotaGigabytes

    A single string.

    The size limit in gigabytes for the mailbox where the user will receive a warning upon reaching or exceeding this size.

    At least one of ProhibitSendQuotaGigabytes, ProhibitSendReceiveQuotaGigabytes or IssueWarningQuotaGigabytes must be provided.

Outputs:

  • Office365SetMailboxesQuotasCsv

    A CSV string containing the information about the mailboxes and quotas which were set.

    The column 'SetMailboxesQuotasOperationApplied' indicates if the action to set the quotas was executed by this task.

    The column 'SetMailboxesQuotasStateAchieved' indicates if the quotas were the required values at the end of the task.

    The column 'SetMailboxesQuotasMessages' contains the warning and/or error messages which were generated while setting the mailbox quotas.

  • Office365SetMailboxesQuotasErrorMessages

    A string containing the error messages which were generated over the course of the task.

Version: 1.0.0

Date: 6 May 2019

Back to top


Set Mailboxes' Retention Policies

Sets the retention policy for Office 365 mailboxes

Inputs:

Usage option 1: Apply a retention policy to multiple mailboxes

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Mailboxes - required

    One or more MSPComplete end user objects.

    The mailboxes which will be receiving the retention policy.

  • RetentionPolicy - required

    A single string.

    The name of the retention policy to apply to the mailboxes.

    A list of retention policies available in the tenant can be retrieved using the Get-RetentionPolicy cmdlet https://docs.microsoft.com/en-us/powershell/module/exchange/policy-and-compliance-retention/get-retentionpolicy?view=exchange-ps.

Usage option 2: Apply retention policies to mailboxes using a CSV string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • MailboxRetentionPoliciesCsv - required

    A CSV string containing the information about the retention policies to apply to the mailboxes.

    Required columns:

    PrimaryEmailAddress

    A single string.

    The primary email address of the mailbox.

    RetentionPolicy

    A single string.

    The name of the retention policy to apply to the mailbox.

    A list of retention policies available in the tenant can be retrieved using the Get-RetentionPolicy cmdlet https://docs.microsoft.com/en-us/powershell/module/exchange/policy-and-compliance-retention/get-retentionpolicy?view=exchange-ps.

Outputs:

  • Office365SetMailboxesRetentionPoliciesCsv

    A CSV string containing the information about the retention policies which were applied to the mailboxes.

    The additional column 'SetMailboxesRetentionPoliciesOperationApplied' indicates if the action to set the mailbox retention policy was successfully executed by this task.

    The additional column 'SetMailboxesRetentionPoliciesStateAchieved' indicates if the at the end of the task the mailbox has the desired retention policy.

    The additional column 'SetMailboxesRetentionPoliciesMessages' contains the warning and/or error messages which were generated while setting the mailbox retention policy.

  • Office365SetMailboxesRetentionPoliciesErrorMessages

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

Version: 1.0.0

Date: 22 May 2019

Back to top


Set Users' Passwords

This sets one or more Office 365 users' passwords.

An option can also be set to force the user to change their password upon the first login.

Inputs:

Usage option 1: Reset a user's password

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials.

  • User - required

    A single MSPComplete end user object.

    This user's password will be set by this task.

  • Password - required

    A single string.

    This specifies the new password for the user.

    This password should meet the organization's Office 365 user password complexity requirements.

  • ForceChangePassword - optional

    A single Boolean value.

    This selects if the user is required to change their password upon the first login.

    Defaults to true.

Usage option 2: Reset users' passwords using a CSV

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials.

  • UsersCsv - required

    A CSV string containing information about the users and passwords to set.

    Required columns:

    PrimaryEmailAddress

    A single string.

    This is the primary email address of the user whose password will be set.

    Password

    A single string.

    This specifies the new password for the user.

    This password should meet the organization's Office 365 user password complexity requirements.

    Optional columns:

    ForceChangePassword

    A single boolean, default value is true.

    This selects if the user is required to change their password upon the first login.

Outputs:

  • Office365SetUsersPasswordsCsv

    A CSV string containing information about the users and passwords that were set.

    An additional column 'SetPassword' is added to indicate if the user password was set

    successfully.

  • Office365SetUsersPasswordsErrorMessages

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

Version: 1.0.3

Date: 17 June 2019

Back to top


Show/Hide Contacts In Address Lists

This sets the visibility of contacts on address lists, including the Global Address List (GAL).

Inputs:

Usage option 1: Show or hide 1 contact

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Identity - required

    A single string.

    The identity of the contact.

    The identity of the contact can be the contact name or email address.

  • ShowOrHide - required

    A single string.

    Specifies whether to show or hide the contact.

    Valid values are 'Show' and 'Hide' (case insensitive).

Usage option 2: Show or hide multiple contacts, using the inputs from a CSV file

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • ContactsCsv - required

    A CSV string containing the information about the contacts to show or hide.

    Required columns:

    Identity

    A single string.

    The identity of the contact.

    The identity of the contact can be the contact name or email address.

    ShowOrHide

    A single string.

    Specifies whether to show or hide the contact.

    Valid values are 'Show' and 'Hide' (case insensitive).

Outputs:

  • Office365ShowHideContactsCsv

    A CSV containing information about the contacts that were shown or hidden.

    A column 'ContactUpdated' is added to indicate if the contact update was successful.

  • Office365ShowHideContactsAllErrorMessages

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

Version: 1.1.5

Date: 18 June 2019

Back to top


Update Contacts

Update Office 365 contact settings using the Set-Contact cmdlet.

This sets the values like the contact's company name, office phone number and mobile phone number, among other settings.

Inputs:

Usage option 1: Set the settings for a contact

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • ContactName - conditionally required

    A single string.

    The name of the contact.

    Either ContactName or ContactExternalEmailAddress must be provided.

  • ContactExternalEmailAddress - conditionally required

    A single string.

    The external email address of the contact.

    Either ContactName or ContactExternalEmailAddress must be provided.

  • FirstName - optional

    A single string.

    The first name of the contact.

  • LastName - optional

    A single string.

    The last name of the contact.

  • Company - optional

    A single string.

    The company name of the contact.

  • Phone - optional

    A single string.

    The office phone number of the contact.

  • MobilePhone - optional

    A single string.

    The mobile phone number of the contact.

  • Title - optional

    A single string.

    The title of the contact.

    Example: Miss

  • WebPage - optional

    A single string.

    The web page of the contact.

  • Fax - optional

    A single string.

    The fax number of the contact.

  • StreetAddress - optional

    A single string.

    The street address of the contact.

  • City - optional

    A single string.

    The city of the contact.

  • StateOrProvince - optional

    A single string.

    The state or province of the contact.

  • PostalCode - optional

    A single string.

    The postal code of the contact.

  • CountryOrRegion - optional

    A single string.

    The country or region of the contact.

    The country or region should be specified as a 2-letter ISO-3166 code.

    Example: US

Usage option 2: Set the settings for multiple contacts, using the inputs from a CSV file

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • ContactsCsv - required

    A CSV string containing the updated information for the contacts.

    Required columns:

    Identity

    A single string.

    Either the name or the external email address of the contact.

    Optional columns:

    FirstName

    A single string.

    The first name of the contact.

    LastName

    A single string.

    The last name of the contact.

    Company

    A single string.

    The company name of the contact.

    Phone

    A single string.

    The office phone number of the contact.

    MobilePhone

    A single string.

    The mobile phone number of the contact.

    Title

    A single string.

    The title of the contact.

    Example: Miss

    WebPage

    A single string.

    The web page of the contact.

    Fax

    A single string.

    The fax number of the contact.

    StreetAddress

    A single string.

    The street address of the contact.

    City

    A single string.

    The city of the contact.

    StateOrProvince

    A single string.

    The state or province of the contact.

    PostalCode

    A single string.

    The postal code of the contact.

    CountryOrRegion

    A single string.

    The country or region of the contact.

    The country or region should be specified as a 2-letter ISO-3166 code.

    Example: US

Outputs:

  • Office365UpdateContactsCsv

    A CSV containing information about the contacts that were updated.

    A column 'ContactUpdated' is added to indicate if the contact update was successful.

  • Office365UpdateContactsAllErrorMessages

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

Version: 1.1.4

Date: 18 June 2019

Back to top


Update Distribution Groups' Members

Updates the members of Office 365 distribution groups

The updated group members can be users or distribution groups.

Inputs:

Usage option 1: Update the members of a distribution group

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the members and groups.

  • DistributionGroup - required

    A single MSPComplete group object.

    This is the group which will have its members updated.

    It needs to have a 'PrimaryEmailAddress' extended property, which is the group's email address in Office 365.

  • MemberUsers - optional

    One or more MSPComplete end user objects.

    These are the users which will become members of the group.

    If both MemberUsers and MemberGroups are not specified, all of the members of the distribution group will be removed.

  • MemberGroups - optional

    One or more MSPComplete group objects.

    They are the groups which will become members of the group.

    All of the group objects need to have a 'PrimaryEmailAddress' extended property, which is the group's email address in Office 365.

    If both MemberUsers and MemberGroups are not specified, all of the members of the distribution group will be removed.

Usage option 2: Update the members of distribution groups

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant containing the members and groups.

  • MembersCsv - required

    A CSV string containing information about the updated members for the groups.

    Required columns:

    DistributionGroupPrimaryEmailAddress

    A single string.

    The primary email address of the distribution group.

    Optional columns:

    MemberPrimaryEmailAddresses

    One or more strings separated by a comma, with the entire string enclosed in double quotes.

    The primary email addresses of the updated members of the distribution group.

    If this is not specified, all of the members of the distribution group will be removed.

Outputs:

  • Office365UpdateDistributionGroupsMembersCsv

    A CSV string containing information about the distribution groups' updated members.

    It contains an additional column 'UpdatedMembers' to indicate if the members were updated successfully.

  • Office365UpdateDistributionGroupsMembersErrorMessages

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

Version: 1.0.1

Date: 2 May 2019

Back to top


Update Mailboxes' Connectivity

Enables/Disables protocols and interfaces for Office 365 mailboxes.

The various protocols and interfaces which can be enabled/disabled are:

- POP

- IMAP

- MAPI

- OWA

- ActiveSync

- EWS

Inputs:

Usage option 1: Apply a set of enable/disable settings for protocols and interfaces to one or more user mailboxes

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UserMailboxes - optional

    One or more MSPComplete end user objects.

    This specifies the Office 365 users which will receive the mailbox connectivity updates.

  • EnableDisablePop - optional

    A single string.

    Valid values are 'Enable' and 'Disable' (case insensitive).

    This specifies if POP should be enabled or disabled for the user mailbox.

  • EnableDisableImap - optional

    A single string.

    Valid values are 'Enable' and 'Disable' (case insensitive).

    This specifies if IMAP should be enabled or disabled for the user mailbox.

  • EnableDisableMapi - optional

    A single string.

    Valid values are 'Enable' and 'Disable' (case insensitive).

    This specifies if MAPI should be enabled or disabled for the user mailbox.

  • EnableDisableOwa - optional

    A single string.

    Valid values are 'Enable' and 'Disable' (case insensitive).

    This specifies if OWA should be enabled or disabled for the user mailbox.

  • EnableDisableActiveSync - optional

    A single string.

    Valid values are 'Enable' and 'Disable' (case insensitive).

    This specifies if ActiveSync should be enabled or disabled for the user mailbox.

  • EnableDisableEws - optional

    A single string.

    Valid values are 'Enable' and 'Disable' (case insensitive).

    This specifies if EWS should be enabled or disabled for the user mailbox.

Usage option 2: Enable/disable protocols and interfaces for mailboxes

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • MailboxesCsv

    A CSV string containing information about the mailboxes which will receive connectivity updates.

    Required columns:

    • Identity

      This specifies the mailbox which will be updated.

      Possible mailbox identities are:

      - Name

      - Display name

      - Alias

      - Distinguished name (DN)

      - Canonical DN

      - DOMAIN_NAME\ACCOUNT_NAME

      - Email address

      - GUID

      - LegacyExchangeDN

      - SamAccountName

      - User ID or user principal name (UPN)

    • MailboxProtocolOrInterface

      This specifies the name of the mailbox protocol or interface which will be enabled

      or disabled.

      Possible values are (case insensitive):

      - POP

      - IMAP

      - MAPI

      - OWA

      - ActiveSync

      - EWS

    • EnableOrDisable

      This specifies whether the mailbox protocol or interface is to be disabled for

      the mailbox.

Outputs:

  • Office365UpdateMailboxesConnectivityCsv

    A CSV string containing information about the mailboxes which were updated, as well as an additional column 'UpdatedMailboxConnectivity' to indicate if the update was successful.

  • Office365UpdateMailboxesConnectivityErrorMessages

    A string containing the error messages which were generated over the course of the task.

Version: 1.0.2

Date: 18 June 2019

Back to top


Update Users V2

Updates one or more Office 365 users' basic properties

Inputs:

Usage option 1: Updates an Office 365 users' basic properties via MSPComplete User object

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • User - required

    A single MSPComplete end user object.

    The user which will receive the property updates.

  • FirstName - optional

    A single string.

    The first name of the user.

  • LastName - optional

    A single string.

    The last name of the user.

  • DisplayName - optional

    A single string.

    The display name of the user.

  • MobilePhoneNumber - optional

    A single string.

    The mobile phone number of the user.

  • TelephoneNumber - optional

    A single string.

    The telephone number of the user.

  • Fax - optional

    A single string.

    The fax number of the user.

  • AlternateEmailAddresses - optional

    A single string.

    The alternate email address for the user.

  • AlternateMobilePhoneNumbers - optional

    A single string.

    The alternate mobile phone number for the user.

  • AddressLine1 - optional

    A single string.

    The first line of the address of the user.

  • City - optional

    A single string.

    The city of the user.

  • StateOrProvince - optional

    A single string.

    The state or province of the user.

  • PostalOrZipCode - optional

    A single string.

    The postal or zip code of the user.

  • CountryOrRegion - optional

    A single string.

    The country or region of the user.

  • Office - optional

    A single string.

    The name of the office of the user.

  • CompanyName - optional

    A single string.

    The name of the company of the user.

  • Department - optional

    A single string.

    The department of the user.

  • JobTitle - optional

    A single string.

    The job title of the user.

  • UsageLocation - optional

    A single string.

    The usage location code for user's account. This is required to be set is licenses are to be assigned to the user.

  • PreferredDataLocation - optional

    A single string.

    The preferred data location for the user.

  • PreferredLanguage - optional

    A single string.

    The preferred language for the user.

  • PasswordNeverExpires - optional

    A single boolean variable.

    Specifies if the user's password will not expire.

  • StrongPasswordRequired - optional

    A single boolean variable.

    Specifies if the user is required to set a password using stronger rules.

Usage option 2: Updates an Office 365 users' basic properties via User Principal Name

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UserPrincipalName - required

    A single string.

    The user principal name of the user which will receive the property updates.

  • User - required

    A single MSPComplete end user object.

    The user which will receive the property updates.

  • FirstName - optional

    A single string.

    The first name of the user.

  • LastName - optional

    A single string.

    The last name of the user.

  • DisplayName - optional

    A single string.

    The display name of the user.

  • MobilePhoneNumber - optional

    A single string.

    The mobile phone number of the user.

  • TelephoneNumber - optional

    A single string.

    The telephone number of the user.

  • Fax - optional

    A single string.

    The fax number of the user.

  • AlternateEmailAddresses - optional

    A single string.

    The alternate email address for the user.

  • AlternateMobilePhoneNumbers - optional

    A single string.

    The alternate mobile phone number for the user.

  • AddressLine1 - optional

    A single string.

    The first line of the address of the user.

  • City - optional

    A single string.

    The city of the user.

  • StateOrProvince - optional

    A single string.

    The state or province of the user.

  • PostalOrZipCode - optional

    A single string.

    The postal or zip code of the user.

  • CountryOrRegion - optional

    A single string.

    The country or region of the user.

  • Office - optional

    A single string.

    The name of the office of the user.

  • CompanyName - optional

    A single string.

    The name of the company of the user.

  • Department - optional

    A single string.

    The department of the user.

  • JobTitle - optional

    A single string.

    The job title of the user.

  • UsageLocation - optional

    A single string.

    The usage location code for user's account. This is required to be set is licenses are to be assigned to the user.

  • PreferredDataLocation - optional

    A single string.

    The preferred data location for the user.

  • PreferredLanguage - optional

    A single string.

    The preferred language for the user.

  • PasswordNeverExpires - optional

    A single boolean variable.

    Specifies if the user's password will not expire.

  • StrongPasswordRequired - optional

    A single boolean variable.

    Specifies if the user is required to set a password using stronger rules.

Usage option 3: Updates one or more Office 365 users' basic properties using a CSV string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UsersInformationCsv - required

    A CSV string containing the information about the user properties to updated.

    Required columns:

    UserPrincipalName

    A single string.

    The user principal name of the user which will receive the property updates.

    Optional columns:

    FirstName

    A single string.

    The first name of the user.

    LastName

    A single string.

    The last name of the user.

    DisplayName

    A single string.

    The display name of the user.

    MobilePhoneNumber

    A single string.

    The mobile phone number of the user.

    TelephoneNumber

    A single string.

    The telephone number of the user.

    Fax

    A single string.

    The fax number of the user.

    AlternateEmailAddresses

    A single string.

    The alternate email address for the user.

    AlternateMobilePhoneNumbers

    A single string.

    The alternate mobile phone number for the user.

    AddressLine1

    A single string.

    The first line of the address of the user.

    City

    A single string.

    The city of the user.

    StateOrProvince

    A single string.

    The state or province of the user.

    PostalOrZipCode

    A single string.

    The postal or zip code of the user.

    CountryOrRegion

    A single string.

    The country or region of the user.

    Office

    A single string.

    The name of the office of the user.

    CompanyName

    A single string.

    The name of the company of the user.

    Department

    A single string.

    The department of the user.

    JobTitle

    A single string.

    The job title of the user.

    UsageLocation

    A single string.

    The usage location code for user's account. This is required to be set is licenses are to be assigned to the user.

    PreferredDataLocation

    A single string.

    The preferred data location for the user.

    PreferredLanguage

    A single string.

    The preferred language for the user.

    PasswordNeverExpires

    A single string.

    Specifies if the user's password will not expire.

    Valid values are 'true' and 'false' (case insensitive).

    StrongPasswordRequired

    A single string.

    Specifies if the user is required to set a password using stronger rules.

    Valid values are 'true' and 'false' (case insensitive).

Outputs:

  • Office365UpdateUsersCsv

    A CSV string containing the information about the user properties which were updated.

    An additional column 'UpdatedProperties' indicates if the properties were successfully updated.

  • Office365UpdateUsersErrorMessages

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

Version: 2.0.1

Date: 9 May 2019

Back to top


Update Users' Domain

Updates the domain for one or more Office 365 users via a User object, User Principal Name or CSV

Inputs:

Usage option 1: Update domain for a user via a MSPComplete User object

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • User - required

    A single MSPComplete end user object.

    User to update the domain for.

  • Domain - required

    A single string.

    The updated domain.

Usage option 2: Update domain for a user via a User Principal Name

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UserPrincipalName - required

    A single string.

    The user principal name of the user to update the domain for.

  • Domain - required

    A single string.

    The updated domain.

Usage option 3: Update domain users using a CSV string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • UsersCsv - required

    Required columns:

    UserPrincipalName

    The user principal name of the user to update the domain for

    Domain

    The updated domain

Outputs:

  • Office365UpdateUsersDomainProcessedUsersCsv

    A CSV containing all the users which were processed by this task, as well as an additional column 'UpdatedDomain' to indicate if the domain was updated successfully.

  • Office365UpdateUsersDomainErrorMessages

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

Version: 1.1.2

Date: 18 June 2019

Back to top


Verify Tenant Domains

Checks if domains are verified in the Office 365 tenant

Inputs:

Usage option 1: Verify domains

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • Domains - required

    One or more strings separated by a new line.

    The domains which will be verified.

  • MaximumWaitTimeMinutes - optional

    A single string.

    The maximum amount of time to wait for the domains to be verified, in minutes.

    The default value is "30".

Usage option 2: Verify domains using a CSV string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials for the tenant.

  • DomainsCsv - required

    A CSV string containing the information of the domains to verify.

    Required columns:

    Domain

    A single string.

    The domain which will be verified.

  • MaximumWaitTimeMinutes - optional

    A single string.

    The maximum amount of time to wait for the domains to be verified, in minutes.

    The default value is "30".

Outputs:

  • Office365VerifyTenantDomainsCsv

    A CSV string containing the the information of the domains which were verified.

    The column 'VerifyTenantDomainsStateAchieved' indicates whether the domain is verified at the end of the task.

    The column 'VerifyTenantDomainsMessages' contains the warning and error messages which were generated while verifying the domain.

  • Office365VerifyTenantDomainsErrorMessages

    A string containing the error messages which were generated over the course of the task.

Version: 1.0.0

Date: 9 May 2019

Back to top


Wait For Mailboxes To Replicate To Exchange Online

Waits for Office 365 mailboxes to be replicated in Exchange Online

Inputs:

Usage option 1: Wait for mailboxes to replicate to Exchange Online specified by end user objects or primary email address

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials.

  • Mailboxes - conditionally required

    One or more MSPComplete end user objects.

    The mailboxes which will be waited on for replication.

    Either Mailboxes or MailboxPrimaryEmailAddresses must be provided.

  • MailboxPrimaryEmailAddresses - conditionally required

    The primary email addresses of the mailboxes which will be waited on for replication.

    Either Mailboxes or MailboxPrimaryEmailAddresses must be provided.

  • MaximumWaitTimeMinutes - optional

    A single string.

    The maximum amount of time to wait for the mailboxes to be replicated, in minutes.

    Defaults to 30.

Usage option 2: Wait for mailboxes to replicate to Exchange Online specified by a CSV string

  • Office365AdministrativeCredentials - required

    A single MSPComplete endpoint object.

    The Office 365 administrative credentials.

  • MailboxesCsv - required

    A CSV string containing the information about the mailboxes which will be waited on for replication.

    Required columns:

    PrimaryEmailAddress

    A single string.

    The primary email address of the mailbox which will be waited on for replication.

  • MaximumWaitTimeMinutes - optional

    A single string.

    The maximum amount of time to wait for the mailboxes to be replicated, in minutes.

    Defaults to 30.

Outputs:

  • Office365WaitForMailboxesToReplicateToExchangeOnlineCsv

    A CSV string containing the information about the mailboxes which were waited on for replication.

    The additional column 'WaitForMailboxesToReplicateToExchangeOnlineStateAchieved' indicates if the at the end of the task the mailbox has been replicated.

    The additional column 'WaitForMailboxesToReplicateToExchangeOnlineMessages' contains the warning and/or error messages which were generated while waiting for the mailbox to be replicated.

  • Office365WaitForMailboxesToReplicateToExchangeOnlineErrorMessages

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

Version: 1.0.0

Date: 22 May 2019

Back to top


Wait for Mailbox Replication V2

Wait for mailbox(es) replication

Inputs:

Usage option 1: Update domain for a user via a MSPComplete User object

  • Office365AdministrativeCredentials

    A MSPComplete endpoint object containing the Office 365 administrative credentials, required.

    The credentials for the tenant to complete the operation on

  • Users

    MSPComplete end user objects, optional

    List of users to confirm that an exchange mailbox exists. If no Users are specified, will check all users within MSOnline to confirm that mailboxes exist

  • MaximumWaitTimeMinutes

    String, optional

    The maximum time (in minutes) the task will take to check that specified / all users have a mailbox. Defaulted to 30 minutes

Outputs:

  • AllErrorMessages

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

Version: 1.0

Date: 28 November 2018

Back to top

Was this article helpful?
0 out of 0 found this helpful