Fortinet Document Library

Version:


Table of Contents

Download PDF
Copy Link

PUT

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

Description

id

string

Yes

The user ID.

realm

string

No

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

username

string

No

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

email

string

No

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

mobile_number

string

No

The user's mobile phone number.

change_token

boolean

No

If the user wants to change one-time password.

token

string

No

The one-time password.

active

boolean

No

If the user is active.

bypass

boolean

No

If the user is bypassed.

lockout

boolean

No

If user is locked out.

user_data

integer

No

The 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’

dst_user_id

string

No

The base user's ID.

is_refid

boolean

No

Whether it is a userref ID.

Example request body:

Input:

{

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

'change_token': True

}

Example of successful response body:

Return:

{

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

'lockout_at': None,

'realm': 'default',

'mobile_number': '+11234567890',

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

'notification_method': 'Email',

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

'updated_at': '2020-02-22T22:33:33',

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

'customer_id': '123456',

'username': 'abc',

'bypass_at': None,

'active': True,

'auth_method': 'FTM',

'fail_times': 0

}

PUT

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

Description

id

string

Yes

The user ID.

realm

string

No

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

username

string

No

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

email

string

No

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

mobile_number

string

No

The user's mobile phone number.

change_token

boolean

No

If the user wants to change one-time password.

token

string

No

The one-time password.

active

boolean

No

If the user is active.

bypass

boolean

No

If the user is bypassed.

lockout

boolean

No

If user is locked out.

user_data

integer

No

The 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’

dst_user_id

string

No

The base user's ID.

is_refid

boolean

No

Whether it is a userref ID.

Example request body:

Input:

{

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

'change_token': True

}

Example of successful response body:

Return:

{

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

'lockout_at': None,

'realm': 'default',

'mobile_number': '+11234567890',

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

'notification_method': 'Email',

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

'updated_at': '2020-02-22T22:33:33',

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

'customer_id': '123456',

'username': 'abc',

'bypass_at': None,

'active': True,

'auth_method': 'FTM',

'fail_times': 0

}