Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Post /policy/supplicant

Post /policy/supplicant

Description

Creates a new Supplicant Policy record, updating instead if the supplied profile has a DBID of one that already exists.

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

POST https://10.106.94.152:8443/api/v2/policy/supplicant

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

{

"dbid": 0,

"rank": 0,

"version": 0,

"lastModifiedBy": "string",

"lastModifiedDate": "2024-02-09T00:09:49.774Z",

"name": "string",

"note": "string",

"profile": {

"dbid": 0,

"name": "string",

"note": "string",

"guid": 0,

"globalModifiedDate": "2024-02-09T00:09:49.774Z",

"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": {

"name": "string",

"note": "string",

"ssid": "string",

"bssid": "string",

"hidden": true,

"security": "string",

"cipher": "string",

"password": "string",

"certificate": "string",

"badSSIDNames": [

{

"dbid": 0,

"parent": "string",

"value": "string"

}

],

"validateServerCertWindows": true,

"eapconfig": "TLS",

"configCipher": "AES",

"badSSIDNameSet": [

"string"

],

"cafingerprint": "string",

"securityType": "OPEN",

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-02-09T00:09:49.774Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"id": 0,

"eapType": "string"

},

"enabled": true,

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-02-09T00:09:49.774Z",

"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"

}

Sample Response

{

"status": "success",

"errorMessage": null

}

Post /policy/supplicant

Post /policy/supplicant

Description

Creates a new Supplicant Policy record, updating instead if the supplied profile has a DBID of one that already exists.

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

POST https://10.106.94.152:8443/api/v2/policy/supplicant

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Request Body

{

"dbid": 0,

"rank": 0,

"version": 0,

"lastModifiedBy": "string",

"lastModifiedDate": "2024-02-09T00:09:49.774Z",

"name": "string",

"note": "string",

"profile": {

"dbid": 0,

"name": "string",

"note": "string",

"guid": 0,

"globalModifiedDate": "2024-02-09T00:09:49.774Z",

"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": {

"name": "string",

"note": "string",

"ssid": "string",

"bssid": "string",

"hidden": true,

"security": "string",

"cipher": "string",

"password": "string",

"certificate": "string",

"badSSIDNames": [

{

"dbid": 0,

"parent": "string",

"value": "string"

}

],

"validateServerCertWindows": true,

"eapconfig": "TLS",

"configCipher": "AES",

"badSSIDNameSet": [

"string"

],

"cafingerprint": "string",

"securityType": "OPEN",

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-02-09T00:09:49.774Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"id": 0,

"eapType": "string"

},

"enabled": true,

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-02-09T00:09:49.774Z",

"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"

}

Sample Response

{

"status": "success",

"errorMessage": null

}