Create an MSP Customer

This procedure outlines how to create an MSP customer account.

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 create a new MSP customer:

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. Verify that the customer does not already exist by checking your list of current customers using the GET method:
   

   GET HTTP://ipAddress/v1/msptenants

   Example: Response

   

   [ {
     "custId" : "MspEndCustomer-tenantid-hcA0LpP5WfsDWs1p",
     "id" : null,
     "accountName" : "msp-customer-01",
     "country" : null,
     "timeZone" : null,
     "mspContact" : {
       "custId" : null,
       "id" : null,
       "contactEmail" : "msp-customer-01@test.com",
       "contactName" : "msp-customer-01",
       "contactPhoneNumber" : "1234567890"
     }
   } ]

3. Create the new customer using the POST method:
   

   POST HTTP://ipAddress/v1/msptenants

   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
   accountName	String	The user-defined account name of the MSP tenant. Validation: Not null and the length must range from 1 to 64.
   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.

Example: Request

{
"accountName" : "msp-end-customer-01",
"country" : "CANADA",
"timeZone" : "America/New_York",
"mspContact":{
   "contactEmail" : "msp-end-customer-01@test.com",
   "contactName" : "msp-end-customer-01",
   "contactPhoneNumber" : "1234567890"
  }
}

Example: Response

{
"custId": "Msp-tenantid-ZRcCOzB7JX52feZd",
"id": null,
"accountName": "msp-end-customer-01",
"country": "CANADA",
"timeZone": "America/New_York",
"mspContact": 
{
"custId": null,
"id": null,
"contactEmail": "msp-end-customer-01@test.com",
"contactName": "msp-end-customer-01",
"contactPhoneNumber": "1234567890"
}
}

Example: Error

{
"errorMessage" : "MSP Tenant not found",
"resource" : "/management/v1/msptenants/Msp-tenantid-swDO5a0sKBCCYAHY",
"errorCode" : 404,
"messageKey": "be.resultCode.msp.tenant.notFound",
"substParams" ; [ ]
  } ]
}