Users

FortiPortal contains a record for each service provider user and customer user in the system. You can use these API endpoints to create a new service provider user.

Get all users

Method	URL	Description	Arguments	Outputs
GET	/users	Retrieve all local service provider and/or customer users in the FortiPortal	userType	JSON array

Arguments

Parameter	Type	Description
userType	String	SP – for service provider users CUST – for customer users Default or no query parameter – returns all users.

Outputs

Parameter	Type	Description
userId	int	user ID.
user Name	String	Name of the site.
firstName	String	First Name of the contact person.
lastName	String	Last Name of the contact person.
email	String	Email address of the contact.
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 service provider user

Method	URL	Description	Arguments	Outputs
POST	/users	Create a new service provider user	See the next table.	userId

Arguments (JSON payload)

Parameter	Type	Required	Description
userName	String		Name of the site.
firstName	String	Y	First Name of the contact person.
lastName	String	Y	Last Name of the contact person.
email	String	Y	Email address of the contact.
password	String		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	String		Country
phone	String		Phone number for the user
fax	String		Fax number for the user
email	String	Y	Email address of the contact person.
userType	String		Type of user. Enter SP.
pwdEnable	boolean		Password policy
roles	JSON array		Array of user roles.

Outputs

Parameter	Type	Description
userId	int	user ID.