Fortinet Document Library

Version:

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

Download PDF
Copy Link

FortiToken Mobile provisioning settings (/fortitokenmobileprovisioning/)

URL:  https://[server_name]/api/[api_version]/fortitokenmobileprovisioning/

This endpoint is used to edit the FortiToken Mobile provisioning settings under System > Administration > FortiGuard.

Supported fields

Field Display name Type Required Other restrictions
server_address The server which provisions the FortiTokens string No The default is "directregistration.fortinet.com" if not specified.
server_port The server port number integer No The default is 433 if not specified.
act_timeout The activation timeout in hours integer No Must be a number between 1 and 168. The default is 1 if not specified.
token_size The size of the token integer No Either 6 or 8. The default is 6 if not specified.
token_algo The type of token algorithm string No Either "totp" or "hotp". The default is "totp" if not specified.
time_step The time step integer No Either 30 or 60. The default is 60 if not specified.
require_pin The setting for whether or not to require a PIN, or to enforce a mandatory PIN string No Either "require", "not_requre", or "enforce". The default is "require" if not specified.
pin_length The pin length integer No Either 4, 6, or 8. The default is 4 if not specified.

Allowed methods

HTTP method Resource URI Action Note
GET /api/v1/fortitokenmobileprovisioning/ Get FortiToken Mobile provisioning settings.  
POST /api/v1/fortitokenmobileprovisioning/ Set FortiToken Mobile provisioning settings. Defaults are used if fields are unspecified.
PATCH /api/v1/fortitokenmobileprovisioning/ Update the specified FortiToken Mobile provisioning settings fields. Previously saved settings are used if unspecified.

FortiToken Mobile provisioning settings (/fortitokenmobileprovisioning/)

URL:  https://[server_name]/api/[api_version]/fortitokenmobileprovisioning/

This endpoint is used to edit the FortiToken Mobile provisioning settings under System > Administration > FortiGuard.

Supported fields

Field Display name Type Required Other restrictions
server_address The server which provisions the FortiTokens string No The default is "directregistration.fortinet.com" if not specified.
server_port The server port number integer No The default is 433 if not specified.
act_timeout The activation timeout in hours integer No Must be a number between 1 and 168. The default is 1 if not specified.
token_size The size of the token integer No Either 6 or 8. The default is 6 if not specified.
token_algo The type of token algorithm string No Either "totp" or "hotp". The default is "totp" if not specified.
time_step The time step integer No Either 30 or 60. The default is 60 if not specified.
require_pin The setting for whether or not to require a PIN, or to enforce a mandatory PIN string No Either "require", "not_requre", or "enforce". The default is "require" if not specified.
pin_length The pin length integer No Either 4, 6, or 8. The default is 4 if not specified.

Allowed methods

HTTP method Resource URI Action Note
GET /api/v1/fortitokenmobileprovisioning/ Get FortiToken Mobile provisioning settings.  
POST /api/v1/fortitokenmobileprovisioning/ Set FortiToken Mobile provisioning settings. Defaults are used if fields are unspecified.
PATCH /api/v1/fortitokenmobileprovisioning/ Update the specified FortiToken Mobile provisioning settings fields. Previously saved settings are used if unspecified.