Customer user

FortiPortal contains a record for each user that is defined for a customer.

Get all customer users

Method	URL	Description	Arguments	Outputs
GET	/customers/{cid}/users	List all users for a particular customer	cid	JSON array

Arguments

Parameter	Type	Description
cid	int	Customer ID.

Outputs

Parameter	Type	Description
	JSON array	Array of customer user records. One entry per customer user, each record contains a unique user ID. See the Customer User Record table.

See the Customer User Record table for the contents of a customer user record.

Get a specific customer user

Method	URL	Description	Arguments	Outputs
GET	/customers/{cid}/users/{uid}	List the user information for a particular user id	cid, uid	customer user record

Arguments

Parameter	Type	Description
cid	int	Customer ID.
uid	int	User ID.

Outputs (customer user record)

The customer user record contains the following fields:

Parameter	Type	Description
usererId	int	User ID.
userName	String	Name of the user.
firstName	String	First name of the user.
lastName	String	Last name of the user.
email	String	Email address of the user.
userType	String	Type of user (customer or SP)
status	String	User status (active or inactive)
roles	JSON array	Roles assigned to the user

Create a new customer user

Method	URL	Description	Arguments	Outputs
POST	/customers/{cid}/users	Create a new user under a particular customer	See the next table.	cid

Arguments

Parameter	Type	Description
cid	int	Customer ID.
customer user fields	JSON payload	See the next table.

Arguments (customer user fields)

Parameter	Type	Required	Description
userName	String	Y	Name of the user.
firstName	String	Y	First name of the user.
lastName	String	Y	Last name of the user.
password	String	Y	Password for the user.
address1	String		Address line 1
address2	String		Address line 2
city	String		Name of the city
state	String		Name of the state
zip	String		Postal code
country			Country
phone	String		Phone number for the user
fax	String		Fax number for the user
email	String	Y	Email address of the contact person.
pwdEnable	boolean		Password policy
roles	JSON array		Array of user roles.

Outputs

Parameter	Type	Description
uid	int	Unique ID of the newly created user.

Edit an existing customer user

Method	URL	Description	Arguments	Outputs
POST	/customers/{cid}/users/{uid}	Edit the existing user information	See the next table.	none

Arguments

Parameter	Type	Description
cid	int	customer ID
uid	int	user ID
customer user fields	JSON payload	See the Arguments (customer user fields) table.

Delete a customer user

Method	URL	Description	Arguments	Outputs
POST	/customers/{cid}/users/delete/{uid}	Delete the user from the customer	none	none

Arguments

Parameter	Type	Description
cid	int	Customer ID.
uid	int	User ID.

No outputs.