Fortinet white logo
Fortinet white logo

Rest API

7.2.0

Get /policy/portal/{id}

Get /policy/portal/{id}

Description

Returns a list of portal policy records matching the supplied filter.

Request Parameter

Id, the portal policy record 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

Sample Request

Request URL

Get https://10.106.94.152:8443/api/v2/policy/portal/1

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"dbid": 0,

"rank": 0,

"version": 0,

"lastModifiedBy": "string",

"lastModifiedDate": "2024-01-02T22:34:57.753Z",

"name": "string",

"note": "string",

"profile": {

"lastModifiedBy": "string",

"lastModifiedDate": "2024-01-02T22:34:57.753Z",

"dbid": 0,

"name": "string",

"note": "string",

"guid": 0,

"globalModifiedDate": "2024-01-02T22:34:57.753Z",

"groupIDs": [

0

],

"catchAll": true,

"weeklySchedule": {

"version": 0,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"daysOfWeek": 0,

"startTimeOfDayAM": true,

"endTimeOfDayAM": true,

"startTimeOfDayHours": 0,

"endTimeOfDayHours": 0,

"startTimeOfDayMinutes": 0,

"endTimeOfDayMinutes": 0,

"alwaysOn": true,

"validTime": true

},

"filterSet": [

"string"

],

"locationIDs": [

0

],

"locationOperator": "OR",

"groupOperator": "OR",

"radiusFilterSet": [

{

"enabled": true,

"methodType": {

"id": 0,

"name": "string",

"shortName": "string"

},

"version": 0,

"encrypted": true,

"priority": 0,

"attributeFilters": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

}

}

],

"groupNames": [

"string"

],

"locationNames": [

"string"

]

},

"configuration": {

"lastModifiedBy": "string",

"lastModifiedDate": "2024-01-02T22:34:57.753Z",

"name": "string",

"note": "string",

"portalElement": {

"landscape": 0,

"id": 0,

"state": "string",

"elementClass": "string",

"role": "string",

"name": "string",

"type": "string",

"protocol": "string",

"status": "string",

"parent": "string",

"suffix": "string",

"version": 0,

"notes": "string",

"description": {},

"group": "string",

"pollingInterval": 0,

"lastPoll": "2024-01-02T22:34:57.753Z",

"lastSuccessfulPoll": "2024-01-02T22:34:57.753Z",

"mibs": [

"string"

],

"sysOid": "string",

"attribute": [

{

"version": 0,

"attributeName": "string",

"attribute": "string",

"table": true,

"discoverObject": true,

"mandatory": true,

"value": "string",

"group": "string",

"type": "string",

"access": "string",

"error": "string",

"objectValue": {},

"attributeSuffix": "string"

}

],

"attributeNames": [

"string"

],

"identification": "string",

"physicalAddress": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"addAuditSummary": "string",

"requestString": "string",

"domainName": "string",

"packedVersion": 0,

"creationEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-01-02T22:34:57.753Z",

"version": 0,

"time": 0,

"eventFormatString": "string",

"empty": true

},

"destroyEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-01-02T22:34:57.753Z",

"version": 0,

"time": 0,

"eventFormatString": "string",

"empty": true

},

"establishedEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-01-02T22:34:57.753Z",

"version": 0,

"time": 0,

"eventFormatString": "string",

"empty": true

},

"lostEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-01-02T22:34:57.753Z",

"version": 0,

"time": 0,

"eventFormatString": "string",

"empty": true

},

"changeMask": 0,

"lastChangeMask": 0

},

"portalID": 0,

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-01-02T22:34:57.753Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"id": 0

},

"enabled": true,

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-01-02T22:34:57.753Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"weeklySchedule": {

"version": 0,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"daysOfWeek": 0,

"startTimeOfDayAM": true,

"endTimeOfDayAM": true,

"startTimeOfDayHours": 0,

"endTimeOfDayHours": 0,

"startTimeOfDayMinutes": 0,

"endTimeOfDayMinutes": 0,

"alwaysOn": true,

"validTime": true

},

"filterSet": [

"string"

],

"configurationName": "string"

}

],

"filtered": 0,

"total": 0

}

Get /policy/portal/{id}

Get /policy/portal/{id}

Description

Returns a list of portal policy records matching the supplied filter.

Request Parameter

Id, the portal policy record 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

Sample Request

Request URL

Get https://10.106.94.152:8443/api/v2/policy/portal/1

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"dbid": 0,

"rank": 0,

"version": 0,

"lastModifiedBy": "string",

"lastModifiedDate": "2024-01-02T22:34:57.753Z",

"name": "string",

"note": "string",

"profile": {

"lastModifiedBy": "string",

"lastModifiedDate": "2024-01-02T22:34:57.753Z",

"dbid": 0,

"name": "string",

"note": "string",

"guid": 0,

"globalModifiedDate": "2024-01-02T22:34:57.753Z",

"groupIDs": [

0

],

"catchAll": true,

"weeklySchedule": {

"version": 0,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"daysOfWeek": 0,

"startTimeOfDayAM": true,

"endTimeOfDayAM": true,

"startTimeOfDayHours": 0,

"endTimeOfDayHours": 0,

"startTimeOfDayMinutes": 0,

"endTimeOfDayMinutes": 0,

"alwaysOn": true,

"validTime": true

},

"filterSet": [

"string"

],

"locationIDs": [

0

],

"locationOperator": "OR",

"groupOperator": "OR",

"radiusFilterSet": [

{

"enabled": true,

"methodType": {

"id": 0,

"name": "string",

"shortName": "string"

},

"version": 0,

"encrypted": true,

"priority": 0,

"attributeFilters": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

}

}

],

"groupNames": [

"string"

],

"locationNames": [

"string"

]

},

"configuration": {

"lastModifiedBy": "string",

"lastModifiedDate": "2024-01-02T22:34:57.753Z",

"name": "string",

"note": "string",

"portalElement": {

"landscape": 0,

"id": 0,

"state": "string",

"elementClass": "string",

"role": "string",

"name": "string",

"type": "string",

"protocol": "string",

"status": "string",

"parent": "string",

"suffix": "string",

"version": 0,

"notes": "string",

"description": {},

"group": "string",

"pollingInterval": 0,

"lastPoll": "2024-01-02T22:34:57.753Z",

"lastSuccessfulPoll": "2024-01-02T22:34:57.753Z",

"mibs": [

"string"

],

"sysOid": "string",

"attribute": [

{

"version": 0,

"attributeName": "string",

"attribute": "string",

"table": true,

"discoverObject": true,

"mandatory": true,

"value": "string",

"group": "string",

"type": "string",

"access": "string",

"error": "string",

"objectValue": {},

"attributeSuffix": "string"

}

],

"attributeNames": [

"string"

],

"identification": "string",

"physicalAddress": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"addAuditSummary": "string",

"requestString": "string",

"domainName": "string",

"packedVersion": 0,

"creationEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-01-02T22:34:57.753Z",

"version": 0,

"time": 0,

"eventFormatString": "string",

"empty": true

},

"destroyEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-01-02T22:34:57.753Z",

"version": 0,

"time": 0,

"eventFormatString": "string",

"empty": true

},

"establishedEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-01-02T22:34:57.753Z",

"version": 0,

"time": 0,

"eventFormatString": "string",

"empty": true

},

"lostEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-01-02T22:34:57.753Z",

"version": 0,

"time": 0,

"eventFormatString": "string",

"empty": true

},

"changeMask": 0,

"lastChangeMask": 0

},

"portalID": 0,

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-01-02T22:34:57.753Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"id": 0

},

"enabled": true,

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-01-02T22:34:57.753Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"weeklySchedule": {

"version": 0,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"daysOfWeek": 0,

"startTimeOfDayAM": true,

"endTimeOfDayAM": true,

"startTimeOfDayHours": 0,

"endTimeOfDayHours": 0,

"startTimeOfDayMinutes": 0,

"endTimeOfDayMinutes": 0,

"alwaysOn": true,

"validTime": true

},

"filterSet": [

"string"

],

"configurationName": "string"

}

],

"filtered": 0,

"total": 0

}