Fortinet white logo
Fortinet white logo

Rest API

7.2.0

Get /user/guest/{id}

Get /user/guest/{id}

Description

Returns the guest account record with the supplied DBID.

Parameter

Id, the DBID of the guest ID.

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/user/guest/1

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "success",

"errorMessage": null,

"results": [

{

"id": 1,

"clientID": -1,

"role": "GuestAccess",

"policy": null,

"firstName": "test",

"lastName": "test",

"sponsor": "admin",

"visitorType": 0,

"assetTag": null,

"email": "adc@def.com",

"userID": "adc@def.com",

"password": "",

"creationTime": 1699482047000,

"validForTime": 1700726399000,

"address": null,

"city": null,

"mailState": null,

"zipCode": null,

"phone": null,

"country": null,

"reason": null,

"personVisiting": null,

"canSendEmail": false,

"canSendSMS": false,

"aupURL": null,

"aupIP": null,

"successURL": "http://www.google.com",

"successIP": "",

"reauthenticationPeriod": -1,

"accountEnabled": true,

"dataFields": "",

"authType": 0,

"authServer": -1,

"regType": 0,

"weeklySchedule": {

"version": 1.1,

"startTimeOfDay": -1,

"endTimeOfDay": -1,

"daysOfWeek": -1,

"alwaysOn": true,

"validTime": true,

"endTimeOfDayAM": true,

"startTimeOfDayAM": true,

"startTimeOfDayHours": 12,

"endTimeOfDayHours": 12,

"startTimeOfDayMinutes": -1,

"endTimeOfDayMinutes": -1

},

"printedNote": null,

"clientIds": [

5

],

"numConferenceAttendees": -1,

"mobileProvider": null,

"mobileNumber": null,

"conferenceName": null,

"accountDuration": -1,

"ncmPropagateHosts": true,

"passwordExclusions": "!@#$%^&*()_+~{}|:\"<>?`-=[]\\;',/",

"sendPasswordSeparately": false,

"minPwLength": 8,

"lastModifiedBy": "SYSTEM",

"lastModifiedDate": "2023-11-08T22:21:32.548+0000",

"lastChangeSummary": "",

"authTypeName": "Local",

"loginAvailabilityString": "Always",

"name": "test, test",

"type": "Guest"

}

],

"filtered": 1,

"total": 1

}

Get /user/guest/{id}

Get /user/guest/{id}

Description

Returns the guest account record with the supplied DBID.

Parameter

Id, the DBID of the guest ID.

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/user/guest/1

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "success",

"errorMessage": null,

"results": [

{

"id": 1,

"clientID": -1,

"role": "GuestAccess",

"policy": null,

"firstName": "test",

"lastName": "test",

"sponsor": "admin",

"visitorType": 0,

"assetTag": null,

"email": "adc@def.com",

"userID": "adc@def.com",

"password": "",

"creationTime": 1699482047000,

"validForTime": 1700726399000,

"address": null,

"city": null,

"mailState": null,

"zipCode": null,

"phone": null,

"country": null,

"reason": null,

"personVisiting": null,

"canSendEmail": false,

"canSendSMS": false,

"aupURL": null,

"aupIP": null,

"successURL": "http://www.google.com",

"successIP": "",

"reauthenticationPeriod": -1,

"accountEnabled": true,

"dataFields": "",

"authType": 0,

"authServer": -1,

"regType": 0,

"weeklySchedule": {

"version": 1.1,

"startTimeOfDay": -1,

"endTimeOfDay": -1,

"daysOfWeek": -1,

"alwaysOn": true,

"validTime": true,

"endTimeOfDayAM": true,

"startTimeOfDayAM": true,

"startTimeOfDayHours": 12,

"endTimeOfDayHours": 12,

"startTimeOfDayMinutes": -1,

"endTimeOfDayMinutes": -1

},

"printedNote": null,

"clientIds": [

5

],

"numConferenceAttendees": -1,

"mobileProvider": null,

"mobileNumber": null,

"conferenceName": null,

"accountDuration": -1,

"ncmPropagateHosts": true,

"passwordExclusions": "!@#$%^&*()_+~{}|:\"<>?`-=[]\\;',/",

"sendPasswordSeparately": false,

"minPwLength": 8,

"lastModifiedBy": "SYSTEM",

"lastModifiedDate": "2023-11-08T22:21:32.548+0000",

"lastChangeSummary": "",

"authTypeName": "Local",

"loginAvailabilityString": "Always",

"name": "test, test",

"type": "Guest"

}

],

"filtered": 1,

"total": 1

}