Customers

FortiPortal contains a record for each customer.

Get all customers

Method	URL	Description	Arguments	Outputs
GET	/customers	Retrieve all customers records	none	JSON array

Arguments

None

Outputs

Parameter	Type	Description
	JSON array	Array of customer records. One entry per customer, each record contains a unique customer ID (cid). See the customer record table.

Get a specific customer

Method	URL	Description	Arguments	Outputs
GET	/customers/{cid}	Retrieve information for a particular customer	cid	customer record

Arguments

Parameter	Type	Description
cid	int	Customer ID

Outputs (customer record)

The customer record contains the following fields:

Parameter	Type	Description
customerId	int	Customer ID
customerName	string	Name of the customer
contactFName	string	First name of the contact person
contactLName	string	Last name of the contact person
contactEmail	string	Email address of the contact person
totalStorage	int	Total customer storage
fpcStorage	int	Storage assigned to portal
collectorStorage	int	Storage assigned to collector
collectorStoragePercentage	string	Collector total percentage (the rest is for portal usage)
fpcStorageUsage	string	Current fpc storage usage
collectorStorageUsage	string	Current collector usage
deviceName	string	Comma-separated list of the name of devices assigned to the customer. You can use this list to calculate the total number of devices for this customer.

Create a new customer

Method	URL	Description	Arguments	Outputs
POST	/customers/	Create a new customer	See the next table.	cid

Arguments (customer fields—JSON payload)

Parameter	Type	Required	Description
customerName	string	Y	Name of the customer
address1	string		Address line 1
address2	string		Address line 2
analyticsEnabled	string	Y	Set to Y or N. NOTE: If you set analyticsEnabled to N, make sure that the totalStorage is set to 50 or more.
city	string		Name of the city
state	string		Name of the state
zip	string		Postal code
phone	string		Phone number for the customer
fax	string		Fax number for the customer
contactFName	string	Y	First name of the contact person
contactLName	string	Y	Last name of the contact person
contactEmail	string	Y	Email address of the contact person
totalStorage	int	Y	Total customer storage. NOTE: When analyticsEnabled is set to N, the storage units are MB. When analyticsEnabledis set to Y, the storage units are GB.
collectorStoragePercentage	int		Collector total percentage (the rest is for portal usage)

Outputs

Parameter	Type	Description
cid	int	Unique customer ID of the newly created customer

Edit an existing customer

Method	URL	Description	Arguments	Outputs
POST	/customers/{cid}	Update the customer record for an existing customer	See the next table.	none

Arguments

Parameter	Type	Description
cid	int	Unique customer ID of the newly created customer
customer fields	JSON payload	See Arguments (customer fields—JSON payload).

Delete a customer record

Method	URL	Description	Arguments	Outputs
POST	/customers/delete/{cid}	Delete a customer from FortiPortal	none	none

Arguments

Parameter	Type	Description
cid	int	Customer ID

No outputs.