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
Secure Networking
Unified SASE
Security Operations
Secure SD-WAN
Secure Access Service Edge (SASE)
ZTNA
LAN Edge
Identity and Access Management
Next Generation 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
  • 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

    • REST API Reference

    Home FortiMail 7.0.0 REST API Reference
    7.0.0
    7.6.0
    7.4.0
    7.2.0
    7.0.0
    6.4.0
    6.2.0
    6.0.4

    REST API for impersonation rule management

    REST API for impersonation rule management

    Impersonation rules lists and entries of each list can be created, deleted, and managed through the REST API.

    View rules list

    Domain level

    curl -b cookie.txt http://<ip >/api/v1/domain/<domain> /ProfImpersonation/<profile_name>/ProfImpersonationEntry

    System level

    curl -b cookie.txt https://<ip>/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry

    View match rules entry

    Domain level

    curl -b cookie.txt http://<ip >/api/v1/domain/<domain> /ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    System level

    curl -b cookie.txt http://<ip >/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    Add a new rule entry

    Note

    For display_name_type, enter 0 for Wildcard or 1 for Regex.

    Domain level

    URL

    HTTP method
    http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> POST
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X POST -d '{"display_name":"hello world","display_name_type":0,"email_address":"hello@world.com"}' http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    System level

    URL

    HTTP method
    http://<ip>/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> POST
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X POST -d '{"display_name":"hello world","display_name_type":0,"email_address":"hello@world.com"}' http://<ip>/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    Modify a rule entry

    Note

    For display_name_type, enter 0 for Wildcard or 1 for Regex.

    Domain level

    URL

    HTTP method
    http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> PUT
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X PUT -d '{"display_name":"new hello world"' http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    System level

    URL

    HTTP method
    http://<ip>/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> PUT
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X PUT -d '{"display_name":"new hello world"' http://<ip>/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    Delete a rule entry

    Domain level

    URL

    HTTP method
    http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> DELETE
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X DELETE http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    System level

    URL

    HTTP method
    http://<ip>/api/v1/ ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> DELETE
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X DELETE http://<ip>/api/v1/ ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    Previous
    Next

    REST API for impersonation rule management

    REST API for impersonation rule management

    Impersonation rules lists and entries of each list can be created, deleted, and managed through the REST API.

    View rules list

    Domain level

    curl -b cookie.txt http://<ip >/api/v1/domain/<domain> /ProfImpersonation/<profile_name>/ProfImpersonationEntry

    System level

    curl -b cookie.txt https://<ip>/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry

    View match rules entry

    Domain level

    curl -b cookie.txt http://<ip >/api/v1/domain/<domain> /ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    System level

    curl -b cookie.txt http://<ip >/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    Add a new rule entry

    Note

    For display_name_type, enter 0 for Wildcard or 1 for Regex.

    Domain level

    URL

    HTTP method
    http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> POST
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X POST -d '{"display_name":"hello world","display_name_type":0,"email_address":"hello@world.com"}' http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    System level

    URL

    HTTP method
    http://<ip>/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> POST
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X POST -d '{"display_name":"hello world","display_name_type":0,"email_address":"hello@world.com"}' http://<ip>/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    Modify a rule entry

    Note

    For display_name_type, enter 0 for Wildcard or 1 for Regex.

    Domain level

    URL

    HTTP method
    http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> PUT
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X PUT -d '{"display_name":"new hello world"' http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    System level

    URL

    HTTP method
    http://<ip>/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> PUT
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X PUT -d '{"display_name":"new hello world"' http://<ip>/api/v1/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    Delete a rule entry

    Domain level

    URL

    HTTP method
    http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> DELETE
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X DELETE http://<ip>/api/v1/domain/<domain>/ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    System level

    URL

    HTTP method
    http://<ip>/api/v1/ ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey> DELETE
    Example:

    curl -b cookie.txt -H 'content-type: application/json' -X DELETE http://<ip>/api/v1/ ProfImpersonation/<profile_name>/ProfImpersonationEntry/<mkey>

    Previous
    Next