icon-unified.svg
Experience Center

Adding SD-WAN Partner API Roles

An SD-WAN partner API role is a specific role for API access to the Internet & SaaS APIs. SD-WAN partner APIs cannot be users; only administrators can be assigned to an SD-WAN partner API role. SD-WAN partner API s can:

  • Make API calls to endpoints that have to do with building tunnels and mapping tunnels to locations.
  • Only access API endpoints, no Admin Portal interactive login allowed.
  • Only perform API calls as it relates to Software-Defined Wide Area Network (SD-WAN) partners, depending on the use case.
  • Have API access using programmatic API calls.
  • Be assigned to read only or read-write permissions to the API endpoints group given in the following procedure.

SD-WAN partner APIs do not have permission to perform the following tasks:

  • Update policy configurations
  • Create or delete users, grant user access to the Admin Portal
  • Change properties or settings within the Admin Portal

An SD-WAN partner API is not the same as a System Integration partner.

To add an SD-WAN partner API role:

  1. Go to Administration > Admin Management > Role Based Access Control > Internet & SaaS.
  2. On the Role Management page, click Add SD-WAN partner API Role.
  3. In the Add SD-WAN Partner API Role window:

    • Name: Enter a name for the SD-WAN partner API role.
    • Access Control: Choose one of the following permissions:
      • Full: Allows SD-WAN partner APIs to view and edit locations and VPN credentials that the partner is managing via the Internet & SaaS API.
      • View Only: Allows SD-WAN partner APIs to view, but not edit, locations and VPN credentials that the partner is managing via the Internet & SaaS API.
    • Partner Access: The integration types the SD-WAN partner API can access via the Internet & SaaS API. If an SD-WAN partner API role does not have access, the option to get or update resources via API will not be available.
      • SD- WAN API Partner access permission allows SD-WAN partner APIs to access the following API endpoints:
        • Locations
        • VPN Credentials
        • Static IP
        • GRE Tunnels

  4. Click Save and activate the change.
Related Articles
About Role ManagementAbout Admin RankAdding Admin RolesAdding SD-WAN Partner API RolesAdding API RolesEditing the Default Executive Insights App Role