Fortinet white logo
Fortinet docs logo DOCUMENT LIBRARY
Fortinet white logo
Fortinet docs logo DOCUMENT LIBRARY
Products Best Practices Hardware Guides Products A-Z
Summary
By Solution
By 4D Pillars
By Cloud
All Products
Secure Networking
Unified SASE
Security Operations
Secure SD-WAN
Secure Access Service Edge (SASE)
ZTNA
LAN Edge
Identity and Access Management
Next Generation Firewall
Web Application Firewall
Public Cloud
Private Cloud
FortiCloud
Secure Networking
  • Hybrid Mesh Firewall
  • NOC Management
  • LAN
  • WAN
    • More >>
    Unified SASE
  • Single Vendor SASE
  • Cloud Network Security
  • Secure Endpoint Connectivity
  • Web Application / API Protection
    • More >>
    Security Operations
  • Security Operations Automation
  • Identity
  • Early Detection & Prevention
    • More >>
    Secure Networking
  • Hybrid Mesh Firewall
  • NOC Management
  • LAN
  • WAN
  • Communication & Surveillance
    • Unified SASE
  • Single Vendor SASE
  • Secure Endpoint Connectivity
  • Cloud Network Security
  • Cloud-Native Security
  • Web Application / API Protection
    • Security Operations
  • Security Operations Automation
  • Endpoint
  • Data Protection
  • Identity
  • Email
  • Early Detection & Prevention
  • Expert Services
  • Edge Firewall
  • Orchestration & management
  • SD Branch
  • Application Delivery
  • Single Vendor SASE
  • Secure Endpoint Connectivity
  • Secure Private Access
  • Thin Edge
  • Identity
  • Application Gateway
  • Enterprise Asset Management
  • Endpoint Agent
  • Agentless Security Posture
  • Identity
  • Wireless
  • Switching
  • Identity
  • Privilege Acccess Management
  • Next Generation Firewall
  • Orchestration & management
  • Expert Services
  • Web Application / API Protection
  • All
  • All
  • Account Management
  • SAAS Management
  • SAAS Application Security
  • Managed Services
  • Platform as a service (PAAS)
  • Other SAAS Services
    • 4D Resources
    Solution Hubs
  • 4D Pillars
  • Cloud
  • Popular Solutions
    • All Products

    REST API Reference

    Home FortiRecorder 7.2.6 REST API Reference
    7.2.6
    7.2.6
    7.2.5
    7.2.4
    7.2.3
    7.2.2
    7.2.1
    7.2.0
    7.0.0
    6.4.0

    Face_recognitionUser

    Face_recognitionUser

    Information about people used to identify them when their face is detected. This is used by face recognition AI on FortiRecorder.

    Permissions required include Camera analytics.

    HTTP Methods

    • GET

    • POST

    • PUT

    • DELETE

    URL

    For HTTP GET, use either:

    • https://HOST_OR_IP/api/v1/Face_recognitionUser/
    • https://HOST_OR_IP/api/v1/Face_recognitionUser/PERSON_NAME/

    For HTTPPOST, PUT, and DELETE, use:

    • https://HOST_OR_IP/api/v1/Face_recognitionUser/PERSON_NAME/

    where variables are:

    • USER_NAME — Unique identifier of a specific person defined for face recognition.

    Response JSON

    For HTTP PUT and POST, responses vary by which settings you changed.

    For HTTP GET, responses vary by URL (collection vs. individual resource): For example, if you get a person profile, your response may look like this:

    {
    "objectID": "Face_recognitionUser:pt001",
    "reqAction": 1,
    "nodePermission": 3,
    "mkey": "pt001",
    "department": "default-department",
    "role": "default-role",
    "display_name": "",
    "image_content": "face-recognition/employees/pt001/default_image.jpg",
    "group1_summary": {
        "images": [
            {
                "image_path": "face-recognition/employees/pt001/group1/image/68_1584718836.jpg",
                "is_local": true,
                "mkey": "68_1584718836"
            },
            { 
                "image_path": "face-recognition/employees/pt001/group1/image/73_1584718823.jpg",
                "is_local": true,
                "mkey": "73_1584718823"
            },
            {
                "image_path": "face-recognition/employees/pt001/group1/image/74_1584718818.jpg",
                "is_local": true,
                "mkey": "74_1584718818"
            }
        ]
    },
    "department_display": "default-department",
    "role_display": "default-role",
    "default_images": "[]",
    "percent": {}
}

    where attributes are:

    • is_local — Whether or not you have already uploaded each thubnail image of the person:

      • true — A thumbnail image exists on FortiRecorder.

      • false — No thumbnail image exists yet on FortiRecorder. You can either upload it via the GUI, or use the REST API. See EmployeeFaceRecord.

    Example: Create a person for face recognition on FortiRecorder

    curl -X POST -b cookie.txt "https://HOST_OR_IP/api/v1/Face_recognitionUser/PERSON_NAME"

    After you create the entry, you must upload thumbnails of the person's face in order for FortiRecorder to be able to identify them. See EmployeeFaceRecord.

    Previous
    Next

    Face_recognitionUser

    Face_recognitionUser

    Information about people used to identify them when their face is detected. This is used by face recognition AI on FortiRecorder.

    Permissions required include Camera analytics.

    HTTP Methods

    • GET

    • POST

    • PUT

    • DELETE

    URL

    For HTTP GET, use either:

    • https://HOST_OR_IP/api/v1/Face_recognitionUser/
    • https://HOST_OR_IP/api/v1/Face_recognitionUser/PERSON_NAME/

    For HTTPPOST, PUT, and DELETE, use:

    • https://HOST_OR_IP/api/v1/Face_recognitionUser/PERSON_NAME/

    where variables are:

    • USER_NAME — Unique identifier of a specific person defined for face recognition.

    Response JSON

    For HTTP PUT and POST, responses vary by which settings you changed.

    For HTTP GET, responses vary by URL (collection vs. individual resource): For example, if you get a person profile, your response may look like this:

    {
    "objectID": "Face_recognitionUser:pt001",
    "reqAction": 1,
    "nodePermission": 3,
    "mkey": "pt001",
    "department": "default-department",
    "role": "default-role",
    "display_name": "",
    "image_content": "face-recognition/employees/pt001/default_image.jpg",
    "group1_summary": {
        "images": [
            {
                "image_path": "face-recognition/employees/pt001/group1/image/68_1584718836.jpg",
                "is_local": true,
                "mkey": "68_1584718836"
            },
            { 
                "image_path": "face-recognition/employees/pt001/group1/image/73_1584718823.jpg",
                "is_local": true,
                "mkey": "73_1584718823"
            },
            {
                "image_path": "face-recognition/employees/pt001/group1/image/74_1584718818.jpg",
                "is_local": true,
                "mkey": "74_1584718818"
            }
        ]
    },
    "department_display": "default-department",
    "role_display": "default-role",
    "default_images": "[]",
    "percent": {}
}

    where attributes are:

    • is_local — Whether or not you have already uploaded each thubnail image of the person:

      • true — A thumbnail image exists on FortiRecorder.

      • false — No thumbnail image exists yet on FortiRecorder. You can either upload it via the GUI, or use the REST API. See EmployeeFaceRecord.

    Example: Create a person for face recognition on FortiRecorder

    curl -X POST -b cookie.txt "https://HOST_OR_IP/api/v1/Face_recognitionUser/PERSON_NAME"

    After you create the entry, you must upload thumbnails of the person's face in order for FortiRecorder to be able to identify them. See EmployeeFaceRecord.

    Previous
    Next