Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /settings/integration/ldap

Get /settings/integration/ldap

Description

Returns all Container records which match 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
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/integration/ldap

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"totalCount": 0,

"results": [

{

"id": 0,

"name": "string",

"ip": "string",

"connectByName": true,

"protocol": "string",

"pollable": true,

"pollInterval": 0,

"deviceGroup": "string",

"type": "string",

"description": "string",

"state": "string",

"status": "string",

"landscape": 0,

"mac": "string",

"ldapSyncState": true,

"ldapAddDirectoryUsers": true,

"ldapDomainName": "string",

"ldapRedundantHost": "string",

"ldapLoginDN": "string",

"ldapPort": 0,

"ldapVersion": "string",

"ldapTimeLimit": "string",

"ldapRemoveClients": "string",

"ldapPassword": "string",

"ldapClientClassObject": "string",

"ldapGroupClassObject": "string",

"ldapSSLConnectionType": "string",

"ldapCharacterSet": "string",

"ldapClientSearchBranch": [

"string"

],

"ldapGroupSearchBranch": [

"string"

],

"clientName": "string",

"clientPassword": "string",

"clientFirstName": "string",

"clientLastName": "string",

"clientID": "string",

"clientAddress": "string",

"clientCity": "string",

"clientState": "string",

"clientZipCode": "string",

"clientTelephoneNumber": "string",

"clientMobileNumber": "string",

"clientMobileProvider": "string",

"clienteMail": "string",

"clientVlanId": "string",

"clientUnitName": "string",

"clientScanPolicy": "string",

"clientNumRecords": "string",

"clientDeleteTime": "string",

"clientDeleteUnits": "string",

"ldapClientDisableAttr": "string",

"ldapClientDisableValue": "string",

"referrals": "string",

"groupName": "string",

"groupMembers": "string",

"clientDN": "string",

"rootDN": "string",

"ldapGroupAllows": [

"string"

],

"me": {

"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-03-13T18:35:55.396Z",

"lastSuccessfulPoll": "2024-03-13T18:35:55.396Z",

"mibs": [

"string"

],

"requestString": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"addAuditSummary": "string",

"physicalAddress": "string",

"domainName": "string",

"identification": "string",

"creationEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"destroyEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"establishedEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"lostEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"packedVersion": 0,

"changeMask": 0,

"sysOid": "string",

"longSuffix": 0,

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

],

"lastChangeMask": 0

},

"pingable": {

"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-03-13T18:35:55.396Z",

"lastSuccessfulPoll": "2024-03-13T18:35:55.396Z",

"mibs": [

"string"

],

"requestString": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"addAuditSummary": "string",

"physicalAddress": "string",

"domainName": "string",

"identification": "string",

"creationEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"destroyEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"establishedEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"lostEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"packedVersion": 0,

"changeMask": 0,

"sysOid": "string",

"longSuffix": 0,

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

],

"lastChangeMask": 0

},

"debug": true,

"tls": {

"encodedValue": [

"string"

],

"id": "string"

},

"ctxEnv": {

"additionalProp1": {},

"additionalProp2": {},

"additionalProp3": {}

},

"clientMSDSPrincipalName": "string",

"attributeDisabled": true,

"clientSAMAccountName": "string",

"samaccountName": "string",

"netBIOSName": "string"

}

]

}

Get /settings/integration/ldap

Get /settings/integration/ldap

Description

Returns all Container records which match 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
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/integration/ldap

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"totalCount": 0,

"results": [

{

"id": 0,

"name": "string",

"ip": "string",

"connectByName": true,

"protocol": "string",

"pollable": true,

"pollInterval": 0,

"deviceGroup": "string",

"type": "string",

"description": "string",

"state": "string",

"status": "string",

"landscape": 0,

"mac": "string",

"ldapSyncState": true,

"ldapAddDirectoryUsers": true,

"ldapDomainName": "string",

"ldapRedundantHost": "string",

"ldapLoginDN": "string",

"ldapPort": 0,

"ldapVersion": "string",

"ldapTimeLimit": "string",

"ldapRemoveClients": "string",

"ldapPassword": "string",

"ldapClientClassObject": "string",

"ldapGroupClassObject": "string",

"ldapSSLConnectionType": "string",

"ldapCharacterSet": "string",

"ldapClientSearchBranch": [

"string"

],

"ldapGroupSearchBranch": [

"string"

],

"clientName": "string",

"clientPassword": "string",

"clientFirstName": "string",

"clientLastName": "string",

"clientID": "string",

"clientAddress": "string",

"clientCity": "string",

"clientState": "string",

"clientZipCode": "string",

"clientTelephoneNumber": "string",

"clientMobileNumber": "string",

"clientMobileProvider": "string",

"clienteMail": "string",

"clientVlanId": "string",

"clientUnitName": "string",

"clientScanPolicy": "string",

"clientNumRecords": "string",

"clientDeleteTime": "string",

"clientDeleteUnits": "string",

"ldapClientDisableAttr": "string",

"ldapClientDisableValue": "string",

"referrals": "string",

"groupName": "string",

"groupMembers": "string",

"clientDN": "string",

"rootDN": "string",

"ldapGroupAllows": [

"string"

],

"me": {

"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-03-13T18:35:55.396Z",

"lastSuccessfulPoll": "2024-03-13T18:35:55.396Z",

"mibs": [

"string"

],

"requestString": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"addAuditSummary": "string",

"physicalAddress": "string",

"domainName": "string",

"identification": "string",

"creationEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"destroyEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"establishedEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"lostEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"packedVersion": 0,

"changeMask": 0,

"sysOid": "string",

"longSuffix": 0,

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

],

"lastChangeMask": 0

},

"pingable": {

"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-03-13T18:35:55.396Z",

"lastSuccessfulPoll": "2024-03-13T18:35:55.396Z",

"mibs": [

"string"

],

"requestString": "string",

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

},

"addAuditSummary": "string",

"physicalAddress": "string",

"domainName": "string",

"identification": "string",

"creationEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"destroyEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"establishedEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"lostEvent": {

"landscape": 0,

"id": 0,

"state": "string",

"name": "string",

"elementType": "string",

"elementID": 0,

"elementName": "string",

"message": "string",

"timeOfEvent": "2024-03-13T18:35:55.396Z",

"version": 0,

"eventFormatString": "string",

"time": 0,

"empty": true

},

"packedVersion": 0,

"changeMask": 0,

"sysOid": "string",

"longSuffix": 0,

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

],

"lastChangeMask": 0

},

"debug": true,

"tls": {

"encodedValue": [

"string"

],

"id": "string"

},

"ctxEnv": {

"additionalProp1": {},

"additionalProp2": {},

"additionalProp3": {}

},

"clientMSDSPrincipalName": "string",

"attributeDisabled": true,

"clientSAMAccountName": "string",

"samaccountName": "string",

"netBIOSName": "string"

}

]

}