Fortinet white logo
Fortinet white logo

Rest API

7.2.0

Get /policy/authentication

Get /policy/authentication

Description

Returns a list of Authentication Policy records matching the supplied filter.

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<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/policy/authentication

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "success",

"errorMessage": null,

"results": [

{

"dbid": 1,

"rank": 1,

"version": 0,

"lastModifiedBy": "SYSTEM",

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

"name": "Global Authentication Conversion",

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

"profile": {

"lastModifiedBy": "SYSTEM",

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

"DBID": 1,

"name": "Global Authentication Conversion",

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

"locationOperator": "OR",

"groupOperator": "OR",

"GUID": null,

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

"groupNames": [],

"weeklySchedule": null,

"groupIDs": [],

"locationIDs": [

8

],

"filterSet": [

{

"filterType": "adapter",

"hostType": "REG_HOST_OR_DEVICE",

"hostTypeIncIPPhone": "false"

}

],

"radiusFilterSet": [],

"locationNames": [

"Forced Authentication"

],

"catchAll": false

},

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

"yamsEventTag": "AUTHENTICATION_POLICY_MODIFICATION",

"auditObj": null,

"auditObjectName": "Global Authentication Conversion",

"auditObjectType": {

"auditTableName": "AuthenticationPolicyAudit",

"mysqlTableName": "AuthenticationPolicy",

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

},

"weeklySchedule": null,

"filterSet": [

{

"filterType": "adapter",

"hostType": "REG_HOST_OR_DEVICE",

"hostTypeIncIPPhone": "false"

}

],

"configurationName": "Global Authentication Conversion"

}

],

"filtered": 1,

"total": 1

}

Get /policy/authentication

Get /policy/authentication

Description

Returns a list of Authentication Policy records matching the supplied filter.

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<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/policy/authentication

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "success",

"errorMessage": null,

"results": [

{

"dbid": 1,

"rank": 1,

"version": 0,

"lastModifiedBy": "SYSTEM",

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

"name": "Global Authentication Conversion",

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

"profile": {

"lastModifiedBy": "SYSTEM",

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

"DBID": 1,

"name": "Global Authentication Conversion",

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

"locationOperator": "OR",

"groupOperator": "OR",

"GUID": null,

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

"groupNames": [],

"weeklySchedule": null,

"groupIDs": [],

"locationIDs": [

8

],

"filterSet": [

{

"filterType": "adapter",

"hostType": "REG_HOST_OR_DEVICE",

"hostTypeIncIPPhone": "false"

}

],

"radiusFilterSet": [],

"locationNames": [

"Forced Authentication"

],

"catchAll": false

},

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

"yamsEventTag": "AUTHENTICATION_POLICY_MODIFICATION",

"auditObj": null,

"auditObjectName": "Global Authentication Conversion",

"auditObjectType": {

"auditTableName": "AuthenticationPolicyAudit",

"mysqlTableName": "AuthenticationPolicy",

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

},

"weeklySchedule": null,

"filterSet": [

{

"filterType": "adapter",

"hostType": "REG_HOST_OR_DEVICE",

"hostTypeIncIPPhone": "false"

}

],

"configurationName": "Global Authentication Conversion"

}

],

"filtered": 1,

"total": 1

}