Fortinet black logo

REST API

User

User

GET

URI:

• /api/v2/user?limit=***

• /api/v2/user?limit=***&page=***

Input fields:
Field Name Type Required

Description

limit

integer

No

The number of users per page.

page

string

No

The cursor of the paginated page to retrieve.
id string No The user ID.
realm_id string No The realm ID.

sn

vdom

string

string

No

No

The serial number of the device.

The VDOM of the auth client.

username

string

No

The username of the end-user.

email

string

No

The end-user's email address.

mobile_number

string

No

The end-user's mobile phone number.

active

boolean

No

Get active user.

bypass_at

datetime

No

The end-user's bypass date and time.

lockout_at

datetime

No

The user's lockout date and time.

user_data

integer

No

User type, which can be either of the following:

  • 0 for local user.
  • 1 for remote LDAP user.

auth_method

string

No

The end-user's authentication method, which can be one of the following:

  • FTM
  • Email
  • SMS
  • FTK

notification_method

string

No

The configured notification method, which can be either of the following:

  • Email
  • SMS

brief

boolean

No

The API response only includes the mobile_number, username, email, vdom, realm, id, user_data if brief=True.

case_accent_sensitive

boolean

No

If the username is case-sensitive.
Successful response fields:
Field name Type Description
customer_id string The customer ID.
client_id string The client ID.
user_id string The user ID.
notification_method string

The configured notification method, which can be either of the following:

  • Email

  • SMS

auth_method string

The end-user's authentication method, which can be one of the following:

  • FTM

  • Email

  • SMS

  • FTK

username string The user name.
id string The userref ID.

mobile_number

string

The end-user's mobile phone number.

email

string

The end-user's email address.

realm_id

string

The realm ID.

active

boolean

If the end-user is active.

created_at

string

The timestamp when the end-user was created.

updated_at

string

The timestamp when the end-user was last updated.

bypass_at

string

The timestamp when the end-user was bypassed for MFA authentication.

lockout_at

string

The timestamp when the end-user was locked out.

fail_times

integer

The number of failed attempts the end-user made when trying to log in.

user_data

integer

The typw of the end-user, which can be either of the following:

  • 0 for local user

  • 1 for remote LDAP user

temp_token

boolean

Whether the end-user is enabled for a temporary token.
Response codes:
Code Response content Description
200 OK The end-user(s) info is successfully returned.
400 Bad Request Auth Client was not found.
402 Payment Required No valid FTC subscription was found. Please enable your free trial or register your purchased license.
403 Forbidden You are not authorized to access user.
404 Not Found

  • Cannot find the related customer info.

  • User does not exist.

Example request body:

None

Example of successful response body:
[ 
   { 
      "auth_method":"FTM", 
      "client_id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx", 
      "created_at":"2020-02-02T02:22:22", 
      "customer_id":"123456", 
      "email":"abc@fortinet.com", 
      "user_data":0, 
      "id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx", 
      "lockout_at":"None", 
      "mobile_number":"1123456789", 
      "notification_method":"Email", 
      "user_id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx", 
      "realm_id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx", 
      "username":"abc", 
      "updated_at":"None", 
      "active":true, 
      "temp_token":false, 
      "bypass_at":"None", 
      "fail_times":0 
   } 
]
Previous
Next

User

GET

URI:

• /api/v2/user?limit=***

• /api/v2/user?limit=***&page=***

Input fields:
Field Name Type Required

Description

limit

integer

No

The number of users per page.

page

string

No

The cursor of the paginated page to retrieve.
id string No The user ID.
realm_id string No The realm ID.

sn

vdom

string

string

No

No

The serial number of the device.

The VDOM of the auth client.

username

string

No

The username of the end-user.

email

string

No

The end-user's email address.

mobile_number

string

No

The end-user's mobile phone number.

active

boolean

No

Get active user.

bypass_at

datetime

No

The end-user's bypass date and time.

lockout_at

datetime

No

The user's lockout date and time.

user_data

integer

No

User type, which can be either of the following:

  • 0 for local user.
  • 1 for remote LDAP user.

auth_method

string

No

The end-user's authentication method, which can be one of the following:

  • FTM
  • Email
  • SMS
  • FTK

notification_method

string

No

The configured notification method, which can be either of the following:

  • Email
  • SMS

brief

boolean

No

The API response only includes the mobile_number, username, email, vdom, realm, id, user_data if brief=True.

case_accent_sensitive

boolean

No

If the username is case-sensitive.
Successful response fields:
Field name Type Description
customer_id string The customer ID.
client_id string The client ID.
user_id string The user ID.
notification_method string

The configured notification method, which can be either of the following:

  • Email

  • SMS

auth_method string

The end-user's authentication method, which can be one of the following:

  • FTM

  • Email

  • SMS

  • FTK

username string The user name.
id string The userref ID.

mobile_number

string

The end-user's mobile phone number.

email

string

The end-user's email address.

realm_id

string

The realm ID.

active

boolean

If the end-user is active.

created_at

string

The timestamp when the end-user was created.

updated_at

string

The timestamp when the end-user was last updated.

bypass_at

string

The timestamp when the end-user was bypassed for MFA authentication.

lockout_at

string

The timestamp when the end-user was locked out.

fail_times

integer

The number of failed attempts the end-user made when trying to log in.

user_data

integer

The typw of the end-user, which can be either of the following:

  • 0 for local user

  • 1 for remote LDAP user

temp_token

boolean

Whether the end-user is enabled for a temporary token.
Response codes:
Code Response content Description
200 OK The end-user(s) info is successfully returned.
400 Bad Request Auth Client was not found.
402 Payment Required No valid FTC subscription was found. Please enable your free trial or register your purchased license.
403 Forbidden You are not authorized to access user.
404 Not Found

  • Cannot find the related customer info.

  • User does not exist.

Example request body:

None

Example of successful response body:
[ 
   { 
      "auth_method":"FTM", 
      "client_id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx", 
      "created_at":"2020-02-02T02:22:22", 
      "customer_id":"123456", 
      "email":"abc@fortinet.com", 
      "user_data":0, 
      "id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx", 
      "lockout_at":"None", 
      "mobile_number":"1123456789", 
      "notification_method":"Email", 
      "user_id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx", 
      "realm_id":"12345678-abcd-efgh-1234-xxxxxxxxxxxx", 
      "username":"abc", 
      "updated_at":"None", 
      "active":true, 
      "temp_token":false, 
      "bypass_at":"None", 
      "fail_times":0 
   } 
]
Previous
Next