Fortinet black logo

DELETE

Copy Link
Copy Doc ID 7e3e6f9e-a082-11ee-8673-fa163e15d75b:895947
Download PDF

DELETE

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

Description

id

string

Yes

The user ID.

username

string

No

The username.

sn

string

No

The serial number of the device.

vdom

string

No

The VDOM of the auth client.

Successful response fields:
Field name Type Description
Response codes:
Code Code content Description
204 NO CONTENT The user has been deleted.
400 Bad Request Cannot identify related customer info.
403 Forbidden You are not allowed to access user.
404 Not Found User does not exist.
409 Conflict Auth client has been locked. No user can be deleted due to the pending task.
Example request body:

None

Example of successful response body:
None.

DELETE

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

Description

id

string

Yes

The user ID.

username

string

No

The username.

sn

string

No

The serial number of the device.

vdom

string

No

The VDOM of the auth client.

Successful response fields:
Field name Type Description
Response codes:
Code Code content Description
204 NO CONTENT The user has been deleted.
400 Bad Request Cannot identify related customer info.
403 Forbidden You are not allowed to access user.
404 Not Found User does not exist.
409 Conflict Auth client has been locked. No user can be deleted due to the pending task.
Example request body:

None

Example of successful response body:
None.