This article provides information on how to use the out-of-the-box task library components within MSPComplete
Tasks
- Accept Reseller Relationship Invitation On Behalf of Customers
- Add Role To Customer User
- Add Subscription to Customer V2
- Allocate Subscriptions to Customers
- Create Customer v2
- Create User(s)
- Delete User(s)
- Generate Request Reseller Relationship Link
- Import Customers Into MSPComplete V2
- Remove Reseller Relationship
- Retrieve Customers V2
- Retrieve Customer Subscriptions
- Set Customer User's Password V2
- Suspend Customer Subscriptions
Accept Reseller Relationship Invitation On Behalf of Customers
Accepts the invitation to establish a Partner Center reseller relationship on behalf of one or more customers.
This script requires node.js installed from https://nodejs.org/en/.
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials is required.
-
RequestResellerRelationshipLink
A single string is required.
This is the link generated in Partner Center to request to establish a reseller relationship with an existing Office 365 tenant.
This link can also be generated by the Partner Center - Generate Request Reseller Relationship Link task.
-
CustomerLoginsCsv
A CSV string containing the information required to log in as each of the customers' Administrators to accept the reseller relationship.
Required columns:
-
UserPrincipalName
A single string.
This is the user principal name of the customer's Administrator account.
-
Password
A single string.
This is the password of the customer's Administrator account.
Optional columns:
-
CustomerId
A single string. Either this or Domain must be provided.
This is the customer ID of the customer represented by this Administrator.
-
Domain
A single string. Either this or CustomerId must be provided.
This is the domain of the customer represented by this Administrator.
-
Outputs
-
UpdatedCustomerLoginsCsv
A CSV string containing the information about each of the customers, as well as an additional column 'AcceptedInvitation' to indicate if the reseller relationship invitation was successfully accepted.
-
AllErrorMessages
A string containing the error messages that were generated over the course of this task.
Version: 1.0.9
Date: 14 March 2019
Add Role To Customer User
Adds roles to users within one or more Partner Center customers
Inputs
Usage option 1: Add a role to a user
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
User
A MSPComplete end-user object is required.
This is the user which will be receiving the role.
Usage option 2: Add roles to multiple users using a CSV string
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
UserRolesToAddCsv
A CSV string containing information about the users and roles will be added.
Required columns:
-
UserPrincipalName
A single string.
This is the user principal name of the user who will be receiving the role.
-
Role
A single string.
This is the role that will be added to the user.
Optional columns:
-
Domain
A single string. Either this or CustomerId must be provided.
This is the domain of the company to which the user belongs.
-
CustomerId
A single string. Either this or the Domain must be provided.
This is the customer ID of the company to which the user belongs.
-
Outputs
-
UpdatedUserRolesToAddCsv
A CSV string containing the information about the users and roles, as well as an additional column 'AddedRole' to indicate if the role was successfully added.
-
AllErrorMessages
A string containing the error messages that were generated over the course of this task.
Version: 1.1.2
Date: 14 March 2019
Add Subscription to Customer V2
Adds a subscription to a Partner Center customer.
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
SubscriptionName
A single string; required.
This is the name of the subscription which will be allocated to the customer.
-
Quantity
A single string; required.
This is the quantity of the subscription which will be allocated to the customer.
-
Domain
A single string; optional. Either this or CustomerId must be provided.
This is the domain of the company which will receive the subscription.
-
CustomerId
A single string; optional Either this or Domain must be provided.
This is the customer ID of the company which will receive the subscription.
Outputs
-
None
Version: 2.0.0
Date: 14 March 2019
Allocate Subscriptions to Customers
Allocates subscriptions to Partner Center Customers as specified in a CSV string.
This task does not check to see if the customer is currently already allocated the subscriptions.
Running this task for a customer with existing subscriptions may result in the customer having extra unused subscriptions.
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
CustomerSubscriptionsCsv
A CSV string containing information about the subscriptions which will be allocated to the customer.
Required columns:
-
Subscription
A single string.
This is the name of the subscription which will be allocated.
-
Quantity
A single string.
This is the quantity of the subscription which will be allocated.
Optional columns:
-
Domain
A single string. Either this or CustomerId must be provided.
This is the domain of the company which will receive the subscription.
-
CustomerId
A single string. Either this or the Domain must be provided.
This is the customer ID of the company which will receive the subscription.
-
Outputs
-
UpdatedCustomerSubscriptionsCsv
A CSV string containing the information about the subscriptions that were allocated to the customer, as well as an additional column 'AllocatedSubscription' to indicate if the allocation succeeded.
If the allocation succeeds, it will contain an 'OrderId' column to indicate the ID of the order used to allocate the subscription.
-
AllErrorMessages
A string containing the error messages which were generated over the course of this task.
Version: 1.3.1
Date: 14 March 2019
Create Customer v2
Creates a Partner Center Customer
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
Domain
A single string; required.
The domain for the new customer.
-
CompanyName
A single string; required.
The company name of the new customer.
-
ContactFirstName
A single string; required.
The first name of the contact person for the new customer.
-
ContactFirstName
A single string; required.
The last name of the contact person for the new customer.
-
ContactEmailAddress
A single string; required.
The email address of the contact person for the new customer.
-
ContactPhoneNumber
A single string; required.
The phone number of the contact person for the new customer.
-
AddressLine1
A single string; required.
The first line of the address of the new customer.
-
AddressLine2
A single string; optional.
The second line of the address of the new customer.
-
City
A single string; required.
The city of the address of the new customer.
-
State
A single string; required.
The state of the address of the new customer.
This should be the abbreviation of the state - for example, Ohio should be entered as 'OH'.
-
PostalCode
A single string; required.
The postal code of the address of the new customer.
-
Country
A single string; required.
The country of the address of the new customer.
This should be the abbreviation of the country - for example, the United States should be entered as 'US'.
-
Language
A single string; required.
The language of the new customer.
This should be the abbreviation of the language - for example, English should be entered as 'en'.
-
Culture
A single string; required.
The culture of the new customer.
This should be the abbreviation of the culture - for example, English for the United States should be entered as 'en-US'.
Outputs
-
None
Version: 2.0.2
Date: 15 March 2019
Create User(s)
Creates new users in one or more Partner Center customers
Inputs
Usage option 1: Create a new user
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
UserPrincipalName
A single string; required.
This is the user principal name of the new user.
-
Password
A single string; required.
This is the password of the new user.
-
FirstName
A single string; optional.
This is the first name of the new user.
-
LastName
A single string; optional.
This is the last name of the new user.
-
UsageLocation
A single string; optional.
This is the usage location of the new user.
This property needs to be set in the user in order to assign licenses to that user.
-
ForceChangePassword
A single boolean variable; optional.
If true, the user will be forced to change their password upon first logging in.
Usage option 2: Create new users using a CSV string
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
UsersToCreateCsv
A CSV string containing the information of the users to create.
Required columns:
-
UserPrincipalName
A single string.
This is the user principal name of the new user.
-
Password
A single string.
This is the password of the new user.
Optional columns:
-
FirstName
A single string.
This is the first name of the new user.
-
LastName
A single string.
This if the last name of the new user.
-
UsageLocation
A single string.
This is the usage location of the new user.
This property needs to be set in the user in order to assign licenses to that user.
-
ForceChangePassword
A single boolean variable.
If true, the user will be forced to change their password upon first logging in.
-
Outputs
-
UpdatedUsersToCreateCsv
A CSV string containing the information about the users, as well as an additional column 'CreatedUser' to indicate if the user was created.
-
AllErrorMessages
A string containing the error messages that were generated over the course of the task.
Version: 1.2.3
Date: 15 March 2019
Delete User(s)
Deletes existing users in one or more Partner Center customers
Inputs
Usage option 1: Delete a user
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
User
A single MSPComplete end-user object is required.
This is the user which will be deleted from the customer.
Usage option 2: Delete users using a CSV string
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials is required.
-
UsersToDeleteCsv
A CSV string containing the information of the users to delete.
Required columns:
-
UserPrincipalName
This is the user principal name of the user which will be deleted.
Optional columns:
-
Domain
A single string. Either this or CustomerId must be provided.
This is the domain of the company to which the user belongs.
-
CustomerId
A single string. Either this or the Domain must be provided.
This is the customer ID of the company to which the user belongs.
-
Outputs
-
UpdatedUsersToDeleteCsv
A CSV string containing the information about the users, as well as an additional column 'DeletedUser' to indicate if the user was deleted.
-
AllErrorMessages
A string containing the error messages that were generated over the course of the task.
Version: 1.2.3
Date: 15 March 2019
Generate Request Reseller Relationship Link
Generates a Partner Center Request Reseller Relationship Link.
A tenant on Office 365 without a reseller can follow this link to establish a new reseller relationship.
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
Outputs
-
RequestResellerRelationshipLink
The link that the tenant's Administrator can follow to establish the reseller relationship.
Version: 1.0.1
Date: 15 March 2019
Import Customers Into MSPComplete V2
Imports all Partner Center customers into MSPComplete.
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
Outputs
-
AllErrorMessages
A string containing the error messages which were generated over the course of the task.
Version: 1.0.1
Date: 15 March 2019
Remove Reseller Relationship
Removes the Partner Center Reseller Relationship with one or more Partner Center customers
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
CustomersCsv
A CSV string containing the information about the customers which will be removed.
Optional columns:
-
Domain
A single string. Either this or CustomerId must be provided.
This is the domain of the company which will be removed.
-
CustomerId
A single string. Either this or Domain must be provided.
This is the customer ID of the company which will be removed.
-
Outputs
-
UpdatedCustomersCsv
A CSV string containing the information about the customers, as well as an additional column 'RemovedResellerRelationship' to indicate if the removal of the relationship was successful.
-
AllErrorMessages
A string containing the error messages which were generated over the course of this task.
Version: 1.2.3
Date: 15 March 2019
Retrieve Customers V2
Retrieves Partner Center customers' information as a CSV string.
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
CompanyNames
One or more strings separated by a comma; optional.
This specifies the company names for the customers which will be retrieved.
-
Domains
One or more strings separated by a comma; optional.
This specifies the domains for the customers which will be retrieved.
Outputs
-
CustomersCsv
A CSV containing the following retrieved information about the customers:
- The customer ID
- The customer domain
- The customer company name
Version: 2.0.1
Date: 3 October 2018
Retrieve Customer Subscriptions
Retrieve Partner Center Customer Subscriptions as a CSV string.
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials; required.
-
CompanyNames
One or more strings separated by a comma; optional.
This specifies the company names for the customers which will be retrieved.
-
Domains
One or more strings separated by a comma; optional.
This specifies the domains for the customers which will be retrieved.
Outputs
-
CustomerSubscriptionsCsv
A CSV containing the following retrieved information about the customers' subscriptions:
-
The customer ID
-
The customer domain
-
The customer company name
-
The subscription name
-
The subscription quantity
-
The order ID of the subscription
-
Whether the subscription is an addon
-
Version: 1.4.2
Date: 15 March 2019
Set Customer User's Password V2
Sets a Partner Center Customer user's password
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials is required.
-
User
A single MSPComplete end-user object is required.
This is the user for which the password will be reset.
-
Password
A single string is required.
This is the new password for the user.
-
ForcePasswordChangeOnNextLogin
A single boolean variable; optional.
If set to true, the user will be forced to change their password upon the next login.
Outputs
-
None
Version: 2.0.0
Date: 15 March 2019
Suspend Customer Subscriptions
Suspends Partner Center customer subscriptions as specified in a CSV string
Inputs
-
PartnerCenterAdministrativeCredentials
An MSPComplete endpoint object containing the Partner Center administrative credentials is required.
-
CustomerSubscriptionsCsv
A CSV string containing information about the subscriptions to be suspended is required.
Required columns:
-
Subscription
A single string.
This is the name of the subscription to suspend.
-
Quantity
A single string.
This is the quantity of the subscription to suspend.
-
Domain
A single string.
This is the domain of the customer for which the subscription will be suspended.
-
OrderId
A single string.
This is the ID of the order which allocated this subscription to the customer.
-
Outputs
-
UpdatedCustomerSubscriptionsCsv
A CSV string containing the information about the subscriptions, as well as an additional column 'SuspendedSubscription' to indicate if the subscription was suspended.
-
AllErrorMessages
A string containing the error messages that were generated over the course of the task.