Fortinet Document Library
Version:
6.4.4
6.4.3
6.4.2
Version:
6.4.1
6.4.0
6.3.3
Version:
6.3.2
6.3.1
6.3.0
Version:
6.2.1
6.2.0
6.1.2
Version:
6.1.1
6.1.0
6.0.7
Version:
6.0.6
6.0.5
6.0.4
Version:
6.0.3
6.0.2
6.0.1
Version:
6.0.0
5.5.0
5.4.0
Version:
5.3.0
5.2.0
5.1.0
Version:
5.0.0
Table of Contents
Introduction
Software versions
What's new in FortiAuthenticator
FortiAuthenticator 6.4.3
FortiAuthenticator 6.4.2
FortiAuthenticator 6.4.1
FortiAuthenticator 6.4.0
The FortiAuthenticator API
Introduction to REST
Initializing the REST API
Accessing the REST API
Filtering query results
Supported API methods
Supported data formats
Resource Summary
Authorization and Permissions
Example API calls
General API usage
User groups (/usergroups/)
FortiTokens (/fortitokens/)
Push authentication (/pushauth/)
Push authentication response (/pushauthresp/)
External IP/FQDN configuration (/system/external_ip_fqdn/)
Local users (/localusers/)
Local API admin (/localapiadmin/)
LDAP users (/ldapusers/)
RADIUS users (/radiususers/)
Local user group memberships (/localgroup-memberships/)
SSO/Remote groups (/ssogroup/)
FortiGate group filter (/fgtgroupfilter/)
SSO authentication (/ssoauth/)
SSO filtering objects (/fgtgroupfilter/[id]/ssofilterobjects/)
Authentication (/auth/)
Realm authentication (/realmauth/)
RADIUS clients (/radiusclients/)
RADIUS policies (/radiuspolicies/)
RADIUS Policy/ Client Associations (/radiuspolicyclient/)
FortiGuard messaging (/fortiguardmessages/)
FTM licenses (/fortitokenmobilelicenses/)
Email servers (/smtpservers/)
User lockout policy (/userlockoutpolicy/)
System Information (/systeminfo/)
Upgrade firmware (/upgrade/)
Syslog servers (/syslogservers/)
Log settings (/logsettings/)
User certificate management (/usercerts/)
SCEP Enrollment Requests Management (/scepregs/)
FTP servers (/ftpservers/)
Licensing (/licensing/)
FortiToken Mobile provisioning settings (/fortitokenmobileprovisioning/)
Scheduled backup settings (/scheduledbackupsettings/)
Fabric integration endpoints (/fabric/)
Fabric authenticate (/fabric/authenticate)
Fabric device status (/fabric/device/status)
Fabric widget (/fabric/widget)
Fabric widget detail by visualization type (/fabric/widget/id)
OAuth server endpoints (/oauth/)
OIDC Authorization (/oauth/authorize/)
OAuth server token (/oauth/token/)
OAuth server revoke token (/oauth/revoke_token/)
OAuth server verify token (/oauth/verify_token/)
OIDC Userinfo (/oauth/userinfo/)
OIDC Keys (/oauth/.well-known/keys/)
OIDC Connect Discovery Info
MAC devices (/macdevices/)
MAC groups (/macgroups/)
MAC device group associations (/macgroup-memberships/)
TACACS+ clients (/tacplusclients/)
TACACS+ policies (/tacpluspolicies/)
TACACS+ policy client association (/tacpluspolicyclient/)
Backup and restore (/recovery/)
IAM accounts (/iamaccounts/)
IAM users (/iamusers/)
Advanced filtering
General filters
General API response codes
Change Log
Home
FortiAuthenticator 6.4.3
REST API Solution Guide
REST API Solution Guide
Introduction
Software versions
What's new in FortiAuthenticator
FortiAuthenticator 6.4.3
FortiAuthenticator 6.4.2
FortiAuthenticator 6.4.1
FortiAuthenticator 6.4.0
The FortiAuthenticator API
Introduction to REST
Initializing the REST API
Accessing the REST API
Filtering query results
Supported API methods
Supported data formats
Resource Summary
Authorization and Permissions
Example API calls
General API usage
User groups (/usergroups/)
FortiTokens (/fortitokens/)
Push authentication (/pushauth/)
Push authentication response (/pushauthresp/)
External IP/FQDN configuration (/system/external_ip_fqdn/)
Local users (/localusers/)
Local API admin (/localapiadmin/)
LDAP users (/ldapusers/)
RADIUS users (/radiususers/)
Local user group memberships (/localgroup-memberships/)
SSO/Remote groups (/ssogroup/)
FortiGate group filter (/fgtgroupfilter/)
SSO authentication (/ssoauth/)
SSO filtering objects (/fgtgroupfilter/[id]/ssofilterobjects/)
Authentication (/auth/)
Realm authentication (/realmauth/)
RADIUS clients (/radiusclients/)
RADIUS policies (/radiuspolicies/)
RADIUS Policy/ Client Associations (/radiuspolicyclient/)
FortiGuard messaging (/fortiguardmessages/)
FTM licenses (/fortitokenmobilelicenses/)
Email servers (/smtpservers/)
User lockout policy (/userlockoutpolicy/)
System Information (/systeminfo/)
Upgrade firmware (/upgrade/)
Syslog servers (/syslogservers/)
Log settings (/logsettings/)
User certificate management (/usercerts/)
SCEP Enrollment Requests Management (/scepregs/)
FTP servers (/ftpservers/)
Licensing (/licensing/)
FortiToken Mobile provisioning settings (/fortitokenmobileprovisioning/)
Scheduled backup settings (/scheduledbackupsettings/)
Fabric integration endpoints (/fabric/)
Fabric authenticate (/fabric/authenticate)
Fabric device status (/fabric/device/status)
Fabric widget (/fabric/widget)
Fabric widget detail by visualization type (/fabric/widget/id)
OAuth server endpoints (/oauth/)
OIDC Authorization (/oauth/authorize/)
OAuth server token (/oauth/token/)
OAuth server revoke token (/oauth/revoke_token/)
OAuth server verify token (/oauth/verify_token/)
OIDC Userinfo (/oauth/userinfo/)
OIDC Keys (/oauth/.well-known/keys/)
OIDC Connect Discovery Info
MAC devices (/macdevices/)
MAC groups (/macgroups/)
MAC device group associations (/macgroup-memberships/)
TACACS+ clients (/tacplusclients/)
TACACS+ policies (/tacpluspolicies/)
TACACS+ policy client association (/tacpluspolicyclient/)
Backup and restore (/recovery/)
IAM accounts (/iamaccounts/)
IAM users (/iamusers/)
Advanced filtering
General filters
General API response codes
Change Log
6.4.3
6.4.4
6.4.3
6.4.2
6.4.1
6.4.0
6.3.3
6.3.2
6.3.1
6.3.0
6.2.1
6.2.0
6.1.2
6.1.1
6.1.0
6.0.7
6.0.6
6.0.5
6.0.4
6.0.3
6.0.2
6.0.1
6.0.0
5.5.0
5.4.0
5.3.0
5.2.0
5.1.0
5.0.0
Download PDF
Copy Link
OAuth server endpoints (/oauth/)
OAuth server token (/oauth/token/)
OIDC Authorization (/oauth/authorize/)
OAuth server revoke token (/oauth/revoke_token/)
OAuth server verify token (/oauth/verify_token/)
OIDC Userinfo (/oauth/userinfo/)
OIDC Keys (/oauth/.well-known/keys/)
OIDC Connect Discovery Info
OAuth server endpoints (/oauth/)
OAuth server token (/oauth/token/)
OIDC Authorization (/oauth/authorize/)
OAuth server revoke token (/oauth/revoke_token/)
OAuth server verify token (/oauth/verify_token/)
OIDC Userinfo (/oauth/userinfo/)
OIDC Keys (/oauth/.well-known/keys/)
OIDC Connect Discovery Info
Link
PDF
TOC