Get /user
Description
Returns all user 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/user |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json
|
Sample Response
{
"status": "success",
"errorMessage": null,
"results": [
{
"landscape": 345052093136,
"id": 3,
"role": "NAC-Default",
"directoryPolicyValue": null,
"firstName": "Admin",
"lastName": "admin",
"dn": "",
"position": "",
"email": "",
"state": 0,
"userID": "admin",
"status": 0,
"notes": "",
"language": "en",
"country": "US",
"version": 1.4,
"packedVersion": 1.4,
"creationTime": 1692982243609,
"validForTime": -1,
"validForInactivityDays": -1,
"validForInactivityAgeTime": 0,
"lastActivityTime": 1708479559407,
"address": "",
"city": "",
"mailState": "",
"zipCode": "",
"phone": "",
"organization": null,
"organizationalUnit": null,
"type": 46,
"adminProfileId": 1,
"guestId": 0,
"mobileNumber": "",
"mobileProvider": "",
"ncmPropagateHosts": true,
"lastModifiedBy": "SYSTEM",
"lastModifiedDate": "2024-02-21T01:39:19.408+0000",
"lastChangeSummary": "[]",
"isApiAdmin": true,
"apiAccessToken": "",
"trustedHosts": "[\"0.0.0.0/0\"]",
"localMschapAuth": false,
"maxAllowedHosts": null
}
{
"landscape": 345052093136,
"id": 4,
"role": "Guest",
"directoryPolicyValue": null,
"firstName": "Guest",
"lastName": "Access",
"dn": null,
"position": null,
"email": null,
"state": 0,
"userID": "guest-access",
"status": 0,
"notes": null,
"language": "en",
"country": "US",
"version": 1.4,
"packedVersion": 1.4,
"creationTime": 1699471318537,
"validForTime": 0,
"validForInactivityDays": 0,
"validForInactivityAgeTime": 0,
"lastActivityTime": 0,
"address": null,
"city": null,
"mailState": null,
"zipCode": null,
"phone": null,
"organization": null,
"organizationalUnit": null,
"type": 51,
"adminProfileId": 0,
"guestId": 0,
"mobileNumber": null,
"mobileProvider": null,
"ncmPropagateHosts": true,
"lastModifiedBy": "admin",
"lastModifiedDate": "2023-11-08T19:32:23.000+0000",
"lastChangeSummary": "[{\"oldVal\":\"*\",\"field\":\"Password\",\"valueHidden\":true,\"newVal\":\"*\"}]",
"isApiAdmin": false,
"apiAccessToken": null,
"trustedHosts": null,
"localMschapAuth": false,
"maxAllowedHosts": null
}
],
"filtered": 2,
"total": 2
}