Fortinet white logo
Fortinet white logo

Rest API

7.2.0

Get /settings/agent/directory-agent/{id}

Get /settings/agent/directory-agent/{id}

Description

Returns a list of Directory Agent Configuration records matching the supplied filter.

Parameters

Id of the Directory Agent Configuration.

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/settings/agent/directory-agent/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": "2023-10-27T18:51:22.158Z",

"name": "string",

"registerRogue": true,

"registerByUser": true,

"appliedGroupName": "string",

"policyName": "string",

"scanGraceLength": 0,

"enabled": true,

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2023-10-27T18:51:22.158Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"addGroupListCopy": [

{

"directoryAgentGroupListItemID": 0,

"addGroupID": 0,

"addGroupName": "string",

"config": "string"

}

],

"addToGroupIDs": [

0

],

"addToGroupNames": [

"string"

],

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

}

}

],

"filtered": 0,

"total": 0

}

Get /settings/agent/directory-agent/{id}

Get /settings/agent/directory-agent/{id}

Description

Returns a list of Directory Agent Configuration records matching the supplied filter.

Parameters

Id of the Directory Agent Configuration.

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/settings/agent/directory-agent/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": "2023-10-27T18:51:22.158Z",

"name": "string",

"registerRogue": true,

"registerByUser": true,

"appliedGroupName": "string",

"policyName": "string",

"scanGraceLength": 0,

"enabled": true,

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2023-10-27T18:51:22.158Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"addGroupListCopy": [

{

"directoryAgentGroupListItemID": 0,

"addGroupID": 0,

"addGroupName": "string",

"config": "string"

}

],

"addToGroupIDs": [

0

],

"addToGroupNames": [

"string"

],

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

}

}

],

"filtered": 0,

"total": 0

}