Move a Customer to a Partner

This procedure outlines how to move an unassigned MSP customer account to an MSP partner. This procedure assumes that the customer has already been created. (It is also possible to move a customer from one partner to another partner using a similar procedure.)

Note

The attributes in this topic are a representative sample of what is a available. For a complete list of attributes, elements, and resources, see the main documentation of the REST API. The documentation resides in a user interface that is accessed using this URL: http://api.extremenetworks.com/extremecloud/rest_api/index.html

To move an unassigned MSP customer to a partner:

1. Log in to the REST API server (api.ezcloudx.com) using MSP Power Admin privileges. You must also forward the credentials with each API call.
2. If needed, verify that the customer does not already exist by checking your list of current customers using the GET method:
   

   GET HTTP://ipAddress/v1/msptenants/nametoidmap

3. Get the MSP partner information:
   

   GET HTTP://ipAddress/v1/msppartners

4. Add the list of tenants to the partner document, and then update the document using the PUT method:
   

   PUT HTTP://ipAddress/v1/msppartners/{tenantId}

   When you POST or PUT data to the REST API, at minimum set the Content-Type header to application/json. However, you should generally specify two headers when you post the log in request.

   Example:

   • 

     content-type: application/json ;charset=UTF-8
     

   • 

     accept: application/json, text/plain, */*

   Any of the following Accept headers are allowed with the Content-Type header request header:

   • accept: application/json
   • accept-encoding: gzip, deflate, br
   • accept-language: en-US,en;q=0.8,und;q=0.6

   

   Request Attributes

   Attribute	Data Type	Description
   tenantId	Path	A non-empty, valid MSP tenant (customer) ID.
   accountName	String	The user-defined account name of the MSP tenant. Validation: Not null and the length must range from 1 to 64.
   entitlements	Array of MSPDeviceEntitlementElement	A list of device entitlements.
   entitlementId	String	The unique identifier of the entitlement being applied. Valid character set: Alphanumeric and special characters, except semi-colon, colon, and ampersand.
   serialNumber	String	The unique identifier of the instance of hardware to which this entitlement applies. Valid character set: Alphanumeric and special characters, except semi-colon, colon, and ampersand.
   country	Country	The country of MSP tenant. Validation: Valid country codes.
   mspContact	MSPContactElement	The contact details of the MSP. Validations: None
   contactEmail	String	The email address of the MSP for business notifications and for service alerts. Validation: A valid email address.
   contactName	String	The contact person for the MSP. Validation: It must be within the range of 1 - 128 characters. Allows alphanumeric and special characters, except semi-colon, colon, and ampersand.
   contactPhoneNumber	String	The phone number of the MSP for business notifications and for service alerts. Validation: None
   timeZone	String	The timezone of the MSP tenant location. Validation: A valid timezone.
   tenants	Array of strings	The list of tenants being assigned to the MSP partner. The tenants must belong to the MSP before they can be assigned to the partner of an MSP. The list of tenants submitted in the response will become the exact list of tenants managed by the MSP partner.
   userId	String	The first power administrator user ID, it must be an email address and must be unique across all of ExtremeCloud. Validations: The user ID must be a not null and non-empty string (email ID) between 1 and 128 characters long. The string will have 63 characters for the local part (the account/name) and 64 for the domain, the @ sign will be counted extra so that sums to 128. Example: {63}@{64}. Valid character set: Alphanumeric and special characters, except semi-colon, colon, and ampersand.

Example: PUT Request

{
   "custId":"MspPartner-tenantid-YLp4lKdq8n6nQNXf",
   "id":null,
   "accountName":"msp-partner-01",
   "mspContact":{"custId":null,"id":null,"contactEmail":"msp-partner-01@test.com","contactName":"msp-partner-01","contactPhoneNumber":"22222222"},
   "userId":null,
   "tenants":["MspEndCustomer-tenantid-TaLDGFSpg7Vgxt7H"],
   "entitlements":[]
}

Example: Response

{
  "custId" : "Msp-tenantid-Nc5YXfsVtOKdMmsj",
  "id" : null,
  "accountName" : "msp-partner-01",
  "mspContact" : {
    "custId" : null,
    "id" : null,
    "contactEmail" : "msp-partner-01@test.com",
    "contactName" : "msp-partner-01",
    "contactPhoneNumber" : "22222222"
  },
  "userId" : null,
  "tenants" : [ "MspEndCustomer-tenantid-TaLDGFSpg7Vgxt7H" ],
  "entitlements" : [ ]
}