Fortinet Document Library

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

Download PDF
Copy Link

Resource Summary

Below are the main resources and the root record which can be accessed via the API:

Resource URL Operation description Supported methods
Root / Allows querying of available resources. GET
Local User Management /localusers/ Allows the creation, modification and deletion of user accounts. GET, POST, PATCH
Local Group Management /usergroups/ Allows the creation and deletion of user groups and specify users within that group. GET, POST, PUT, DELETE
LDAP Users /ldapusers/ Allows querying of LDAP user records and updating of specific fields. Allows triggering of out of band (email//SMS tokens to LDAP users. GET, POST, PATCH, DELETE
RADIUS users /radiususers/ Allows querying of RADIUS user records and update of specific fields. Allows triggering of out of band (email//SMS tokens to RADIUS users. GET, POST, PATCH, DELETE
Local Group Membership /localgroup-memberships/ Represents local user group membership resource (relationship between local user and local user group). GET, POST, DELETE
User Authentication /auth/ Allows validation of user authentication credentials. POST
FortiToken /fortitokens/ Allows provisioning of FortiTokens. GET
Push Authentication /pushauth/ Allows token code validation from a user's FortiToken Mobile app. POST
Push Authentication Response /pushauthresp/ Allows FortiToken Mobile devices to submit the response to a token code validation request triggered by a prior call to the /pushauth/ endpoint. POST
SSO Group /ssogroup/ Enables remote configuration of the Fortinet SSO Methods & Dynamic Policies > SSO > SSO Groups table. GET, POST, DELETE
FortiGate Filter Group /fgtgroupfilter/ Enables remote configuration of the Fortinet SSO Methods & Dynamic Policies > SSO > FortiGate Filtering table. GET, PUT
SSO Authentication /ssoauth/ Adds/removes a user from the FSSO logged in users table. POST
Syslog Servers /syslogservers/ Allows creating, updating, editing, and deleting of syslog servers. GET, POST, PATCH, DELETE
Log Settings /logsettings/ Allows editing of log settings. GET, POST, PATCH
User Certificate Management /usercerts/ Allows renewing and revoking of user certificates. GET, POST, PATCH

Resource Summary

Below are the main resources and the root record which can be accessed via the API:

Resource URL Operation description Supported methods
Root / Allows querying of available resources. GET
Local User Management /localusers/ Allows the creation, modification and deletion of user accounts. GET, POST, PATCH
Local Group Management /usergroups/ Allows the creation and deletion of user groups and specify users within that group. GET, POST, PUT, DELETE
LDAP Users /ldapusers/ Allows querying of LDAP user records and updating of specific fields. Allows triggering of out of band (email//SMS tokens to LDAP users. GET, POST, PATCH, DELETE
RADIUS users /radiususers/ Allows querying of RADIUS user records and update of specific fields. Allows triggering of out of band (email//SMS tokens to RADIUS users. GET, POST, PATCH, DELETE
Local Group Membership /localgroup-memberships/ Represents local user group membership resource (relationship between local user and local user group). GET, POST, DELETE
User Authentication /auth/ Allows validation of user authentication credentials. POST
FortiToken /fortitokens/ Allows provisioning of FortiTokens. GET
Push Authentication /pushauth/ Allows token code validation from a user's FortiToken Mobile app. POST
Push Authentication Response /pushauthresp/ Allows FortiToken Mobile devices to submit the response to a token code validation request triggered by a prior call to the /pushauth/ endpoint. POST
SSO Group /ssogroup/ Enables remote configuration of the Fortinet SSO Methods & Dynamic Policies > SSO > SSO Groups table. GET, POST, DELETE
FortiGate Filter Group /fgtgroupfilter/ Enables remote configuration of the Fortinet SSO Methods & Dynamic Policies > SSO > FortiGate Filtering table. GET, PUT
SSO Authentication /ssoauth/ Adds/removes a user from the FSSO logged in users table. POST
Syslog Servers /syslogservers/ Allows creating, updating, editing, and deleting of syslog servers. GET, POST, PATCH, DELETE
Log Settings /logsettings/ Allows editing of log settings. GET, POST, PATCH
User Certificate Management /usercerts/ Allows renewing and revoking of user certificates. GET, POST, PATCH