Fortinet Document Library

Version:

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

Download PDF
Copy Link

FTM licenses (/fortitokenmobilelicenses/)

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

This endpoint is used to query FTM token license status inlcuding the number of FTM tokens in the licenses and the total number of available tokens for use. It's also used to activate an FTM token license.

Supported fields

Field Display name Type Required Other restrictions
license FortiToken Mobile license string Yes Only valid in POST method.
total_ftm Total number of FortiToken Mobiles on the FortiAuthenticator integer No Read-only field returned by the GET method.
used_ftm Number of FortiToken Mobiles assigned to users integer No Read-only field returned by the GET method.
available_ftm Number of FortiToken Mobiles available for future assignments integer No Read-only field returned by the GET method.

Allowed methods

HTTP method Resource URI Action Notes
GET /api/v1/fortitokenmobilelicenses/ Get licensed FortiToken Mobiles statistics. Returns total_ftm, used_ftm, and available_ftm fields.
POST /api/v1/fortitokenmobilelicenses/ Activate a FortiToken Mobile license. Requires license field.

Examples

curl -k -v \-u "webadmin:[hash]" \ https://[FAC_IP]/api/v1/fortitokenmobilelicenses/

 

Response : {"available_ftm": 30, "total_ftm": 32, "used_ftm": 2}

 

curl -k -v -X POST \

https://[FAC_IP]/api/v1/fortitokenmobilelicenses/ \

-H 'Content-Type: application/json' \

-u "webadmin:[hash]" \

-d '{"license": "####-####-####-####-####"}'

 

Response : {

"license": "####-####-####-####-####",

"messages": {

"success": "Successfully imported 10 FortiTokens"

}

}

FTM licenses (/fortitokenmobilelicenses/)

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

This endpoint is used to query FTM token license status inlcuding the number of FTM tokens in the licenses and the total number of available tokens for use. It's also used to activate an FTM token license.

Supported fields

Field Display name Type Required Other restrictions
license FortiToken Mobile license string Yes Only valid in POST method.
total_ftm Total number of FortiToken Mobiles on the FortiAuthenticator integer No Read-only field returned by the GET method.
used_ftm Number of FortiToken Mobiles assigned to users integer No Read-only field returned by the GET method.
available_ftm Number of FortiToken Mobiles available for future assignments integer No Read-only field returned by the GET method.

Allowed methods

HTTP method Resource URI Action Notes
GET /api/v1/fortitokenmobilelicenses/ Get licensed FortiToken Mobiles statistics. Returns total_ftm, used_ftm, and available_ftm fields.
POST /api/v1/fortitokenmobilelicenses/ Activate a FortiToken Mobile license. Requires license field.

Examples

curl -k -v \-u "webadmin:[hash]" \ https://[FAC_IP]/api/v1/fortitokenmobilelicenses/

 

Response : {"available_ftm": 30, "total_ftm": 32, "used_ftm": 2}

 

curl -k -v -X POST \

https://[FAC_IP]/api/v1/fortitokenmobilelicenses/ \

-H 'Content-Type: application/json' \

-u "webadmin:[hash]" \

-d '{"license": "####-####-####-####-####"}'

 

Response : {

"license": "####-####-####-####-####",

"messages": {

"success": "Successfully imported 10 FortiTokens"

}

}