Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /user/guest/count

Get /user/guest/count

Description

Returns a count of guest account 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

Sample Request

Request URL

GET https://10.106.94.152:8443/api/v2/user/guest/count

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"conferenceRegistrations": {

"additionalProp1": 0,

"additionalProp2": 0,

"additionalProp3": 0

},

"results": [

{

"landscape": 0,

"id": 0,

"role": "string",

"policy": "string",

"firstName": "string",

"lastName": "string",

"sponsor": "string",

"visitorType": 0,

"assetTag": "string",

"email": "string",

"state": "string",

"userID": "string",

"password": "string",

"version": 0,

"packedVersion": 0,

"creationTime": "2024-04-18T21:49:04.659Z",

"validForTime": "2024-04-18T21:49:04.659Z",

"address": "string",

"city": "string",

"mailState": "string",

"zipCode": "string",

"phone": "string",

"country": "string",

"reason": "string",

"personVisiting": "string",

"canSendEmail": true,

"canSendSMS": true,

"aupURL": "string",

"aupIP": "string",

"successURL": "string",

"successIP": "string",

"reauthenticationPeriod": 0,

"accountEnabled": true,

"dataFields": "string",

"authType": 0,

"authServer": 0,

"regType": 0,

"weeklySchedule": {

"version": 0,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"daysOfWeek": 0,

"validTime": true,

"alwaysOn": true,

"startTimeOfDayAM": true,

"endTimeOfDayAM": true,

"startTimeOfDayHours": 0,

"endTimeOfDayHours": 0,

"startTimeOfDayMinutes": 0,

"endTimeOfDayMinutes": 0

},

"terminateAtEndOfDay": true,

"printedNote": "string",

"numConferenceAttendees": 0,

"mobileProvider": "string",

"mobileNumber": "string",

"conferenceName": "string",

"accountDuration": 0,

"ncmPropagateHosts": true,

"passwordExclusions": "string",

"sendPasswordSeparately": true,

"minPwLength": 0,

"lastModifiedBy": "string",

"lastModifiedDate": "2024-04-18T21:49:04.659Z",

"alwaysOn": true,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"clientIDs": [

0

],

"startTimeOfDayAM": true,

"endTimeOfDayAM": true,

"startTimeOfDayHours": 0,

"endTimeOfDayHours": 0,

"startTimeOfDayMinutes": 0,

"endTimeOfDayMinutes": 0,

"daysOfWeek": 0,

"timeOfDayString": "string",

"loginAvailabilityString": "string",

"authTypeName": "string",

"daysOfWeekString": "string",

"guestValid": true,

"userStartTime": "2024-04-18T21:49:04.659Z",

"userEndTime": "2024-04-18T21:49:04.659Z",

"conference": true,

"individualUserName": true,

"sharedUserName": true,

"userStartTimeStr": "string",

"userEndTimeStr": "string",

"name": "string",

"type": "string",

"creationTimeMillis": 0,

"validForTimeMillis": 0

}

],

"filtered": 0,

"total": 0

}

Get /user/guest/count

Get /user/guest/count

Description

Returns a count of guest account 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

Sample Request

Request URL

GET https://10.106.94.152:8443/api/v2/user/guest/count

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"conferenceRegistrations": {

"additionalProp1": 0,

"additionalProp2": 0,

"additionalProp3": 0

},

"results": [

{

"landscape": 0,

"id": 0,

"role": "string",

"policy": "string",

"firstName": "string",

"lastName": "string",

"sponsor": "string",

"visitorType": 0,

"assetTag": "string",

"email": "string",

"state": "string",

"userID": "string",

"password": "string",

"version": 0,

"packedVersion": 0,

"creationTime": "2024-04-18T21:49:04.659Z",

"validForTime": "2024-04-18T21:49:04.659Z",

"address": "string",

"city": "string",

"mailState": "string",

"zipCode": "string",

"phone": "string",

"country": "string",

"reason": "string",

"personVisiting": "string",

"canSendEmail": true,

"canSendSMS": true,

"aupURL": "string",

"aupIP": "string",

"successURL": "string",

"successIP": "string",

"reauthenticationPeriod": 0,

"accountEnabled": true,

"dataFields": "string",

"authType": 0,

"authServer": 0,

"regType": 0,

"weeklySchedule": {

"version": 0,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"daysOfWeek": 0,

"validTime": true,

"alwaysOn": true,

"startTimeOfDayAM": true,

"endTimeOfDayAM": true,

"startTimeOfDayHours": 0,

"endTimeOfDayHours": 0,

"startTimeOfDayMinutes": 0,

"endTimeOfDayMinutes": 0

},

"terminateAtEndOfDay": true,

"printedNote": "string",

"numConferenceAttendees": 0,

"mobileProvider": "string",

"mobileNumber": "string",

"conferenceName": "string",

"accountDuration": 0,

"ncmPropagateHosts": true,

"passwordExclusions": "string",

"sendPasswordSeparately": true,

"minPwLength": 0,

"lastModifiedBy": "string",

"lastModifiedDate": "2024-04-18T21:49:04.659Z",

"alwaysOn": true,

"startTimeOfDay": 0,

"endTimeOfDay": 0,

"clientIDs": [

0

],

"startTimeOfDayAM": true,

"endTimeOfDayAM": true,

"startTimeOfDayHours": 0,

"endTimeOfDayHours": 0,

"startTimeOfDayMinutes": 0,

"endTimeOfDayMinutes": 0,

"daysOfWeek": 0,

"timeOfDayString": "string",

"loginAvailabilityString": "string",

"authTypeName": "string",

"daysOfWeekString": "string",

"guestValid": true,

"userStartTime": "2024-04-18T21:49:04.659Z",

"userEndTime": "2024-04-18T21:49:04.659Z",

"conference": true,

"individualUserName": true,

"sharedUserName": true,

"userStartTimeStr": "string",

"userEndTimeStr": "string",

"name": "string",

"type": "string",

"creationTimeMillis": 0,

"validForTimeMillis": 0

}

],

"filtered": 0,

"total": 0

}