Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /host/multifilter/users

Get /host/multifilter/users

Description

Returns all Host Records, with User and Adapter information, which match the supplied multifilter string.

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiNAC
Content-Type (option 1) application/json String

Content-Type (option 2)

application/xml

Request Body Parameters

Name

Required

Type

filter Optional Array

pods

Optional

Array<String>

start Optional Integer
count Optional Integer
sortKey Optional String
sortDir Optional String

Sample Request

Request URL

GET https://10.106.94.152:8443/api/v2/host/multifilter/users

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"total": 0,

"filtered": 0,

"results": [

{

"serverIP": "string",

"serverName": "string",

"serverPort": "string",

"host_status": 0,

"host_id": 0,

"host_creationTime": 0,

"host_validTime": 0,

"host_offlineAgeTime": 0,

"host_validForTimeOffline": 0,

"host_lastSuccessful": 0,

"host_containerID": 0,

"host_containerName": "string",

"host_role": "string",

"host_directoryPolicyValue": "string",

"host_pcSerialNumber": "string",

"host_hardwareType": "string",

"host_notes": "string",

"host_operatingSystem": "string",

"host_applications": "string",

"host_type": "string",

"host_owner": "string",

"host_loggedOnUserId": "string",

"host_hasPersistentAgent": true,

"host_communicatingPersistentAgent": true,

"host_isMessageReceiver": true,

"host_agentVersion": "string",

"host_agentPlatform": "string",

"host_agentTag": "string",

"host_agentID": "string",

"host_deviceType": "string",

"host_isMdmCompliance": true,

"host_isMdmCompromised": true,

"host_isMdmDataProtection": true,

"host_isMdmPasscodePresent": true,

"host_isManagedByMDM": true,

"host_vulnerabilityScanStatus": 0,

"host_vulnerabilityScanDate": 0,

"host_openPorts": "string",

"host_criticality": "string",

"host_lastModifiedBy": "string",

"host_lastModifiedDate": "2024-03-01T00:13:52.922Z",

"host_hostName": "string",

"host_img": "string",

"user_isDeleteHostsUponExpiration": true,

"user_status": 0,

"user_id": 0,

"user_firstName": "string",

"user_lastName": "string",

"user_userID": "string",

"user_position": "string",

"user_notes": "string",

"user_email": "string",

"user_address": "string",

"user_city": "string",

"user_zipCode": "string",

"user_type": "string",

"user_mailState": "string",

"user_phone": "string",

"user_dn": "string",

"user_role": "string",

"user_directoryPolicyValue": "string",

"user_creationTime": 0,

"user_validForTimeMS": 0,

"user_lastActivityTime": 0,

"user_maxHosts": "string",

"user_mobileProvider": "string",

"user_mobileNumber": "string",

"user_isNcmPropagateHosts": true,

"user_validForInactivityDays": 0,

"user_validForInactivityAgeTime": 0,

"user_lastModifiedBy": "string",

"user_lastModifiedDate": "2024-03-01T00:13:52.922Z",

"user_guestID": 0,

"user_authenticateType": "string",

"user_img": "string",

"user_hasMph": true,

"adapter_status": 0,

"adapter_id": 0,

"adapter_ip": "string",

"adapter_ips": [

{

"ip": "string",

"type": "string",

"adapterID": 0

}

],

"adapter_pcType": "string",

"adapter_userID": "string",

"adapter_accessValue": "string",

"adapter_physicalAddress": "string",

"adapter_location": "string",

"adapter_mediumType": "string",

"adapter_vendorName": "string",

"adapter_container": "string",

"adapter_dpcRuleName": "string",

"adapter_authType": "string",

"adapter_innerEapType": "string",

"adapter_outerEapType": "string",

"adapter_type": "string",

"adapter_deviceType": "string",

"adapter_img": "string"

}

]

}

Get /host/multifilter/users

Get /host/multifilter/users

Description

Returns all Host Records, with User and Adapter information, which match the supplied multifilter string.

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiNAC
Content-Type (option 1) application/json String

Content-Type (option 2)

application/xml

Request Body Parameters

Name

Required

Type

filter Optional Array

pods

Optional

Array<String>

start Optional Integer
count Optional Integer
sortKey Optional String
sortDir Optional String

Sample Request

Request URL

GET https://10.106.94.152:8443/api/v2/host/multifilter/users

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"total": 0,

"filtered": 0,

"results": [

{

"serverIP": "string",

"serverName": "string",

"serverPort": "string",

"host_status": 0,

"host_id": 0,

"host_creationTime": 0,

"host_validTime": 0,

"host_offlineAgeTime": 0,

"host_validForTimeOffline": 0,

"host_lastSuccessful": 0,

"host_containerID": 0,

"host_containerName": "string",

"host_role": "string",

"host_directoryPolicyValue": "string",

"host_pcSerialNumber": "string",

"host_hardwareType": "string",

"host_notes": "string",

"host_operatingSystem": "string",

"host_applications": "string",

"host_type": "string",

"host_owner": "string",

"host_loggedOnUserId": "string",

"host_hasPersistentAgent": true,

"host_communicatingPersistentAgent": true,

"host_isMessageReceiver": true,

"host_agentVersion": "string",

"host_agentPlatform": "string",

"host_agentTag": "string",

"host_agentID": "string",

"host_deviceType": "string",

"host_isMdmCompliance": true,

"host_isMdmCompromised": true,

"host_isMdmDataProtection": true,

"host_isMdmPasscodePresent": true,

"host_isManagedByMDM": true,

"host_vulnerabilityScanStatus": 0,

"host_vulnerabilityScanDate": 0,

"host_openPorts": "string",

"host_criticality": "string",

"host_lastModifiedBy": "string",

"host_lastModifiedDate": "2024-03-01T00:13:52.922Z",

"host_hostName": "string",

"host_img": "string",

"user_isDeleteHostsUponExpiration": true,

"user_status": 0,

"user_id": 0,

"user_firstName": "string",

"user_lastName": "string",

"user_userID": "string",

"user_position": "string",

"user_notes": "string",

"user_email": "string",

"user_address": "string",

"user_city": "string",

"user_zipCode": "string",

"user_type": "string",

"user_mailState": "string",

"user_phone": "string",

"user_dn": "string",

"user_role": "string",

"user_directoryPolicyValue": "string",

"user_creationTime": 0,

"user_validForTimeMS": 0,

"user_lastActivityTime": 0,

"user_maxHosts": "string",

"user_mobileProvider": "string",

"user_mobileNumber": "string",

"user_isNcmPropagateHosts": true,

"user_validForInactivityDays": 0,

"user_validForInactivityAgeTime": 0,

"user_lastModifiedBy": "string",

"user_lastModifiedDate": "2024-03-01T00:13:52.922Z",

"user_guestID": 0,

"user_authenticateType": "string",

"user_img": "string",

"user_hasMph": true,

"adapter_status": 0,

"adapter_id": 0,

"adapter_ip": "string",

"adapter_ips": [

{

"ip": "string",

"type": "string",

"adapterID": 0

}

],

"adapter_pcType": "string",

"adapter_userID": "string",

"adapter_accessValue": "string",

"adapter_physicalAddress": "string",

"adapter_location": "string",

"adapter_mediumType": "string",

"adapter_vendorName": "string",

"adapter_container": "string",

"adapter_dpcRuleName": "string",

"adapter_authType": "string",

"adapter_innerEapType": "string",

"adapter_outerEapType": "string",

"adapter_type": "string",

"adapter_deviceType": "string",

"adapter_img": "string"

}

]

}