Fortinet Document Library

Version:

Version:

Version:


Table of Contents

REST API Solution Guide

Download PDF
Copy Link

RADIUS users (/radiususers/)

URL:  https://[server_name]/api/v1/radiususers/

This endpoint represents imported remote RADIUS user resource.

Supported fields

Field Display name Type Required Other restrictions
username Username string Yes Read Only
server_name Server name string Yes, if creating user Read Only
server_address Server address string Yes, if creating user Read Only
email E-mail address string No Must be a valid e-mail address
active Account Status boolean No  
mobile_number Mobile number string No max length = 25, must follow international number format: +[country_code]-[number]
token_auth Token Auth boolean No Whether second factor authentication should be enabled. If true, token_type is required.
token_type Token Type string No One of ftk, ftm, email, sms. If email is chosen, email is required. If SMS is chosen, mobile_number is required.
token_serial Token Serial string No If token_type is ftm, or ftk, and this is not present or blank, the next available token will be assigned.
ftm_act_method FTM Activation Delivery Method string No One of email or 'sms', if email is chosen, email is required. If SMS is chosen,mobile_number` is required.

Allowed methods

HTTP method Resource URI Action
GET /api/v1/radiususers/ Get all non-admin RADIUS users
GET /api/v1/radiususers/[id]/ Get a specific non-admin RADIUS user
POST /api/v1/radiususers/[id]/sendoobtoken/ Create a new RADIUS user
POST /api/v1/radiususers/[id]/sendoobtoken/ Send an out-of-band token code (email/SMS token) to a RADIUS user
PATCH /api/v1/radiususers/[id]/ Update specified fields for a specific RADIUS user with ID id
DELETE /api/v1/radiususers/[id]/ Delete a RADIUS user

Allowed filters

Field Lookup expressions Values
username exact, iexact, contains, icontains, in  
email exact, iexact, contains, icontains, in  
active exact  
server_name exact, iexact, contains, icontains  
server_address exact, iexact, contains, icontains  
token_type   ftk, ftm, email, sms
token_serial exact, iexact  

Third-party integration: FTM provisioning

This resource allows for FTM provisioning in the same manner specified above for remote LDAP users.

RADIUS users (/radiususers/)

URL:  https://[server_name]/api/v1/radiususers/

This endpoint represents imported remote RADIUS user resource.

Supported fields

Field Display name Type Required Other restrictions
username Username string Yes Read Only
server_name Server name string Yes, if creating user Read Only
server_address Server address string Yes, if creating user Read Only
email E-mail address string No Must be a valid e-mail address
active Account Status boolean No  
mobile_number Mobile number string No max length = 25, must follow international number format: +[country_code]-[number]
token_auth Token Auth boolean No Whether second factor authentication should be enabled. If true, token_type is required.
token_type Token Type string No One of ftk, ftm, email, sms. If email is chosen, email is required. If SMS is chosen, mobile_number is required.
token_serial Token Serial string No If token_type is ftm, or ftk, and this is not present or blank, the next available token will be assigned.
ftm_act_method FTM Activation Delivery Method string No One of email or 'sms', if email is chosen, email is required. If SMS is chosen,mobile_number` is required.

Allowed methods

HTTP method Resource URI Action
GET /api/v1/radiususers/ Get all non-admin RADIUS users
GET /api/v1/radiususers/[id]/ Get a specific non-admin RADIUS user
POST /api/v1/radiususers/[id]/sendoobtoken/ Create a new RADIUS user
POST /api/v1/radiususers/[id]/sendoobtoken/ Send an out-of-band token code (email/SMS token) to a RADIUS user
PATCH /api/v1/radiususers/[id]/ Update specified fields for a specific RADIUS user with ID id
DELETE /api/v1/radiususers/[id]/ Delete a RADIUS user

Allowed filters

Field Lookup expressions Values
username exact, iexact, contains, icontains, in  
email exact, iexact, contains, icontains, in  
active exact  
server_name exact, iexact, contains, icontains  
server_address exact, iexact, contains, icontains  
token_type   ftk, ftm, email, sms
token_serial exact, iexact  

Third-party integration: FTM provisioning

This resource allows for FTM provisioning in the same manner specified above for remote LDAP users.