Fortinet Document Library

Version:


Table of Contents

Download PDF
Copy Link

GET

URI:
  • /api/v1/user?username=***&realm_id=***

  • /api/v1/user/[id]
  • /api/v1/user
Input fields:
Field Name Type Required

Description

id string No The user ID.
realm_id string No The realm ID.

realm

string

No

The realm name.

username

string

No

 

email

string

No

The user's email address.

mobile_number

string

No

The user's mobile phone number.

active

boolean

No

Get active user.

bypass_at

datetime

No

The 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

  • 0 for local user
  • 1 for remote LDAP user

auth_method

string

No

The authentication method, which can be one of the following:

  • ‘FTM’
  • ‘Email’
  • ‘SMS’
  • ‘FTK’

notification_method

string

No

Supported notification method, which can either of

  • ‘Email’
  • ‘SMS’

brief

boolean

No

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

Example request body:
Input: 
None
Example of successful response body:

Return:

[{

'active': true,

'auth_method': 'FTM',

'bypass_at': None,

'client_id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',

'created_at': '2020-02-02T02:22:22',

'customer_id': '123456',

'email': 'abc@fortinet.com',

'user_data': 0,

'fail_times': 0,

'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',

'lockout_at': None,

'mobile_number': None,

'notification_method': 'Email',

'realm': 'default',

'realm_id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',

'updated_at': None,

'user_id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',

'username': 'abc'

}]

Note

The response body will be a user dictionary if the API input field is set to request a specific user, for example, get a user by its ID. Otherwise, the response body will be a list of user dictionaries.

GET

URI:
  • /api/v1/user?username=***&realm_id=***

  • /api/v1/user/[id]
  • /api/v1/user
Input fields:
Field Name Type Required

Description

id string No The user ID.
realm_id string No The realm ID.

realm

string

No

The realm name.

username

string

No

 

email

string

No

The user's email address.

mobile_number

string

No

The user's mobile phone number.

active

boolean

No

Get active user.

bypass_at

datetime

No

The 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

  • 0 for local user
  • 1 for remote LDAP user

auth_method

string

No

The authentication method, which can be one of the following:

  • ‘FTM’
  • ‘Email’
  • ‘SMS’
  • ‘FTK’

notification_method

string

No

Supported notification method, which can either of

  • ‘Email’
  • ‘SMS’

brief

boolean

No

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

Example request body:
Input: 
None
Example of successful response body:

Return:

[{

'active': true,

'auth_method': 'FTM',

'bypass_at': None,

'client_id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',

'created_at': '2020-02-02T02:22:22',

'customer_id': '123456',

'email': 'abc@fortinet.com',

'user_data': 0,

'fail_times': 0,

'id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',

'lockout_at': None,

'mobile_number': None,

'notification_method': 'Email',

'realm': 'default',

'realm_id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',

'updated_at': None,

'user_id': '12345678-abcd-efgh-1234-xxxxxxxxxxxx',

'username': 'abc'

}]

Note

The response body will be a user dictionary if the API input field is set to request a specific user, for example, get a user by its ID. Otherwise, the response body will be a list of user dictionaries.