Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /host/{id}/policy

Get /host/{id}/policy

Description

Returns the policy info for a Host Record based on the provided id.

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

id Optional Integer

Sample Request

Request URL

GET https://10.106.94.152:8443/api/v2/host/32/policy

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

id:xxxx

Sample Response

{

"status": "success",

"errorMessage": null,

"accessPolicy": null,

"accessPolicyDebug": null,

"supplicantPolicy": null,

"supplicantPolicyDebug": null,

"epcPolicy": null,

"epcPolicyDebug": null,

"portalPolicy": null,

"portalPolicyDebug": null

"authenticationPolicy": {

"dbid": 3,

"rank": 2,

"version": 0,

"lastModifiedBy": "admin",

"lastModifiedDate": "2023-09-21T22:58:21.000+0000",

"name": "Guest Self-Registration Access Policy 2",

"note": "",

"profile": {

"lastModifiedBy": "admin",

"lastModifiedDate": "2023-09-21T22:58:21.000+0000",

"DBID": 3,

"name": "Role Test 3",

"note": "",

"locationOperator": "OR",

"groupOperator": "OR",

"GUID": null,

"globalModifiedDate": "2023-09-21T22:58:21.000+0000",

"groupNames": [],

"weeklySchedule": {

"version": 1.1,

"startTimeOfDay": -1,

"endTimeOfDay": -1,

"daysOfWeek": -1,

"alwaysOn": true,

"validTime": true,

"endTimeOfDayAM": true,

"startTimeOfDayAM": true,

"startTimeOfDayHours": 12,

"endTimeOfDayHours": 12,

"startTimeOfDayMinutes": -1,

"endTimeOfDayMinutes": -1

},

"groupIDs": [],

"locationIDs": [],

"filterSet": [],

"locationNames": [],

"catchAll": true,

"radiusFilterSet": []

},

"configuration": {

"name": "Global Authentication Conversion",

"note": "Converted from Global Authentication Policy - Fri Aug 25 13:40:35 EDT 2023",

"authenticationMethod": null,

"authenticationTime": 0,

"authenticationTimeOffLine": 600000,

"reauthentication": false,

"reauthenticationTime": 0,

"errorMessage": null,

"lastModifiedBy": "SYSTEM",

"lastModifiedDate": "2023-08-25T17:40:35.000+0000",

"id": 1

},

"enabled": true,

"auditObjectName": "Guest Self-Registration Access Policy 2",

"auditObjectType": {

"auditTableName": "AuthenticationPolicyAudit",

"mysqlTableName": "AuthenticationPolicy",

"idnameQuery": "select ID,NAME from AuthenticationPolicy where ID in"

},

"yamsEventTag": "AUTHENTICATION_POLICY_MODIFICATION",

"auditObj": null,

"weeklySchedule": {

"version": 1.1,

"startTimeOfDay": -1,

"endTimeOfDay": -1,

"daysOfWeek": -1,

"alwaysOn": true,

"validTime": true,

"endTimeOfDayAM": true,

"startTimeOfDayAM": true,

"startTimeOfDayHours": 12,

"endTimeOfDayHours": 12,

"startTimeOfDayMinutes": -1,

"endTimeOfDayMinutes": -1

},

"filterSet": [],

"configurationName": "Global Authentication Conversion"

},

"authenticationPolicyDebug": null

}

Get /host/{id}/policy

Get /host/{id}/policy

Description

Returns the policy info for a Host Record based on the provided id.

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

id Optional Integer

Sample Request

Request URL

GET https://10.106.94.152:8443/api/v2/host/32/policy

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

id:xxxx

Sample Response

{

"status": "success",

"errorMessage": null,

"accessPolicy": null,

"accessPolicyDebug": null,

"supplicantPolicy": null,

"supplicantPolicyDebug": null,

"epcPolicy": null,

"epcPolicyDebug": null,

"portalPolicy": null,

"portalPolicyDebug": null

"authenticationPolicy": {

"dbid": 3,

"rank": 2,

"version": 0,

"lastModifiedBy": "admin",

"lastModifiedDate": "2023-09-21T22:58:21.000+0000",

"name": "Guest Self-Registration Access Policy 2",

"note": "",

"profile": {

"lastModifiedBy": "admin",

"lastModifiedDate": "2023-09-21T22:58:21.000+0000",

"DBID": 3,

"name": "Role Test 3",

"note": "",

"locationOperator": "OR",

"groupOperator": "OR",

"GUID": null,

"globalModifiedDate": "2023-09-21T22:58:21.000+0000",

"groupNames": [],

"weeklySchedule": {

"version": 1.1,

"startTimeOfDay": -1,

"endTimeOfDay": -1,

"daysOfWeek": -1,

"alwaysOn": true,

"validTime": true,

"endTimeOfDayAM": true,

"startTimeOfDayAM": true,

"startTimeOfDayHours": 12,

"endTimeOfDayHours": 12,

"startTimeOfDayMinutes": -1,

"endTimeOfDayMinutes": -1

},

"groupIDs": [],

"locationIDs": [],

"filterSet": [],

"locationNames": [],

"catchAll": true,

"radiusFilterSet": []

},

"configuration": {

"name": "Global Authentication Conversion",

"note": "Converted from Global Authentication Policy - Fri Aug 25 13:40:35 EDT 2023",

"authenticationMethod": null,

"authenticationTime": 0,

"authenticationTimeOffLine": 600000,

"reauthentication": false,

"reauthenticationTime": 0,

"errorMessage": null,

"lastModifiedBy": "SYSTEM",

"lastModifiedDate": "2023-08-25T17:40:35.000+0000",

"id": 1

},

"enabled": true,

"auditObjectName": "Guest Self-Registration Access Policy 2",

"auditObjectType": {

"auditTableName": "AuthenticationPolicyAudit",

"mysqlTableName": "AuthenticationPolicy",

"idnameQuery": "select ID,NAME from AuthenticationPolicy where ID in"

},

"yamsEventTag": "AUTHENTICATION_POLICY_MODIFICATION",

"auditObj": null,

"weeklySchedule": {

"version": 1.1,

"startTimeOfDay": -1,

"endTimeOfDay": -1,

"daysOfWeek": -1,

"alwaysOn": true,

"validTime": true,

"endTimeOfDayAM": true,

"startTimeOfDayAM": true,

"startTimeOfDayHours": 12,

"endTimeOfDayHours": 12,

"startTimeOfDayMinutes": -1,

"endTimeOfDayMinutes": -1

},

"filterSet": [],

"configurationName": "Global Authentication Conversion"

},

"authenticationPolicyDebug": null

}