Fortinet Document Library

Version:


Table of Contents

Download PDF
Copy Link

POST

URI:
  • /api/v1/user
Input fields:
/>
Field Name Type Required

Description

realm

string

No

The realm name, which can be up to 80 characters in length.

username

string

Yes

The username, which can be up to 80 characters in length.

email

string

Yes

The user's email address, which can be up to 80 characters in length.

mobile_number

string

No

The user's mobile phone number.

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’
Example request body:

Input:

{

'username': 'abc',

'realm': 'default',

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

'mobile_number': '+11234567890'

}

Example of successful response body:

Return:

{

'active': true,

'auth_method': 'FTM',

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

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

'updated_at': None,

'lockout_at': None,

'bypass_at': None,

'customer_id': '123456',

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

'user_data': 0,

'fail_times': 0,

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

'mobile_number': '+11234567890',

'notification_method': 'Email',

'realm': 'default',

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

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

'username': 'abc'

}

POST

URI:
  • /api/v1/user
Input fields:
/>
Field Name Type Required

Description

realm

string

No

The realm name, which can be up to 80 characters in length.

username

string

Yes

The username, which can be up to 80 characters in length.

email

string

Yes

The user's email address, which can be up to 80 characters in length.

mobile_number

string

No

The user's mobile phone number.

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’
Example request body:

Input:

{

'username': 'abc',

'realm': 'default',

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

'mobile_number': '+11234567890'

}

Example of successful response body:

Return:

{

'active': true,

'auth_method': 'FTM',

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

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

'updated_at': None,

'lockout_at': None,

'bypass_at': None,

'customer_id': '123456',

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

'user_data': 0,

'fail_times': 0,

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

'mobile_number': '+11234567890',

'notification_method': 'Email',

'realm': 'default',

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

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

'username': 'abc'

}