Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /settings/agent/directory-agent

Get /settings/agent/directory-agent

Description

Returns a list of Device Identity Source 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/settings/agent/directory-agent

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-04-17T21:08:26.604Z",

"name": "string",

"registerRogue": true,

"registerByUser": true,

"appliedGroupName": "string",

"policyName": "string",

"scanGraceLength": 0,

"enabled": true,

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-04-17T21:08:26.604Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"addGroupListCopy": [

{

"directoryAgentGroupListItemID": 0,

"addGroupID": 0,

"addGroupName": "string",

"config": "string"

}

],

"addToGroupIDs": [

0

],

"addToGroupNames": [

"string"

]

}

],

"filtered": 0,

"total": 0

}

Get /settings/agent/directory-agent

Get /settings/agent/directory-agent

Description

Returns a list of Device Identity Source 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/settings/agent/directory-agent

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-04-17T21:08:26.604Z",

"name": "string",

"registerRogue": true,

"registerByUser": true,

"appliedGroupName": "string",

"policyName": "string",

"scanGraceLength": 0,

"enabled": true,

"auditObj": {

"auditDBID": 0,

"liveDBID": 0,

"liveObj": {

"auditObj": "string",

"yamsEventTag": "string"

},

"user": "string",

"action": "string",

"timestamp": "2024-04-17T21:08:26.604Z",

"auditObj": "string",

"yamsEventTag": "string"

},

"yamsEventTag": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"addGroupListCopy": [

{

"directoryAgentGroupListItemID": 0,

"addGroupID": 0,

"addGroupName": "string",

"config": "string"

}

],

"addToGroupIDs": [

0

],

"addToGroupNames": [

"string"

]

}

],

"filtered": 0,

"total": 0

}