Skip to main content
Index

Reseller Customer Management

You can manage your Equinix Customer Portal customer accounts with the following use cases. 

Create new customer account

create-new-customer-account-v2.1

Step 1: Authenticate

Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.

 

Refer to Generating a Client ID and Client Secret key under Getting Started section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens for instructions on how to call Oauth API to validate and authenticate your credentials.

 

If you are unaware of your user credentials for Equinix Customer Portal, contact your local Equinix Service Desk. 

Step 2: Get Reseller Details

2a) Get your reseller account number

Determine the account number of the reseller for which you would be creating a new customer.

 

This value will be passed in the request in Step 3 for the following URL parameter: accountNumber.

 

Refer to GET Resellers under the API Reference section for instructions on how to get your reseller account number. You may skip this step if you already know this number.

 

2b) Get reseller notification contact's username

2bi) Determine the username of your notification contact

 

To verify this username belongs to your notification contact, proceed to Step 2bii.

 

When you are certain this is the intended username, proceed to Step 3, where this value will be passed in the request body for the following parameter: resellerNotificationContact.

 

Refer to GET Users under the API Reference section for instructions on how to get all your users. You may skip this step if you know this username.

 

2bii) Verify username

 

Ensure the user profile details match the details of your notification contact.

 

Refer to GET Users {username} under the API Reference section for instructions on how to get your user profile. You may skip this step if you are certain this is the intended user.

Step 3: Create New Customer Account

POST /resellers/{accountNumber}/customers

 Method  POST
 URL or End Point  /v2/resellers/{accountNumber}/customers
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  customerAccountName, resellerNotificationContact, address {addressLine1, addressLine2, city, state, countryCode, zipCode }, permittedServices [...]

 

This method creates a new customer for your reseller account. Only an authenticated user who is a Master Administrator in your organization may create a customer. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show sample curl requests for the different scenarios. 

 

Creating a customer without specifying permitted services

 

curl -X

POST "https://api.equinix.com/v2/resellers"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
   "customerAccountName": "Acme Corp 1",
  "resellerNotificationContact": "john_doe1",
  "address": {
    "addressLine1": "1123 Main Street",
    "addressLine2": "#10-11",
    "city": "Main City",
    "state": "California",
    "countryCode": "US",
    "zipCode": 91024
  }
}'

 

Creating a customer with specified permissions

 

curl -X

POST "https://api.equinix.com/v2/resellers"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
   "customerAccountName": "Acme Corp 1",
  "resellerNotificationContact": "john_doe1",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "#10-11",
    "city": "Main City",
    "state": "California",
    "countryCode": "US",
    "zipCode": "91024"
  },

  "permittedServices": [
    "NETWORK_EDGE"
  ]
}'

 

The description of the URL parameter is as follows:

 

URL Parameter Name

Mandatory Type Example Description
accountNumber Yes string 123456

Your reseller account number.

 

The description of the body parameters is as follows:

 

Body
Parameter Name

Mandatory Type Example Applicable Values Description
customerAccountName Yes string Acme Corp 1  

Name of your customer account. This is free text input.

Limit: 100 characters

resellerNotificationContact Yes string john_doe1  

Equinix-registered username of your organization's Equinix Customer Portal user, who will serve as the notification contact for your customer.

 

Only 1 username is allowed. The Equinix Customer Portal user's status must be active or locked. If the user's status is not any of these, the request will fail. Refer to GET Users for more information.

address Yes object     Customer address. This object comprises the following body parameters: addressLine1, addressLine2, city, state, countryCode, zipCode, permittedServices. 
addressLine1 Yes string 123 Main Street   Line 1 of the customer address. This is free text input. 

Limit: 1 to 100 characters.
addressLine2 No string #10-11   Line 2 of the customer address. This is free text input. 

Limit: 1 to 100 characters.
city Yes string Main City   City.

Limit: 1 to 100 characters.
state Yes string California   State.

Limit: 1 to 100 characters.
countryCode Yes string US

Click here for applicable values.

Country code. 

 

Format: ISO-3166 ALPHA-2 code.

zipCode Yes string 91024   Postal code or zip code.

Limit: 1 to 100 characters.
permittedServices No array
[strings]
NETWORK_EDGE NETWORK_EDGE

Allows customers' users to view permissions for specified services.

Permitted Services - Description
NETWORK_EDGE - Allows customers' users to view Network Edge permissions.

 

A customer is successfully created for reseller account when HTTP code 202 is returned.

 

To update, remove, or check the status of your customer account, see Resellers (V2) for more information. 

 

If you get “Insufficient permissions” error, contact your local Equinix Service Desk.