Skip To Content
ArcGIS Developers
Dashboard

Import Entitlements

  • URL:https://<licenses-url>/importEntitlements(POST only)
  • Required Capability:Administrator
  • Version Introduced:10.3.0

Description

Note:

This operation is only applicable to ArcGIS Enterprise 10.6.1 or before.

This operation allows you to import entitlements for ArcGIS Pro and additional products such as ArcGIS Navigator into your licensing portal. Once the entitlements have been imported, you can assign licenses to users within your portal. The operation requires an entitlements file that has been exported out of your ArcGIS License Server Administrator or out of My Esri, depending on the product.

A typical entitlements file will have multiple parts, each representing a set of entitlements that are effective at a specific date. The parts that are effective immediately will be configured to be the current entitlements. Other parts will be added to a queue. The portal framework will automatically apply the parts when they become effective. You can use the Get Entitlements operation to see the parts that are in the queue.

Each time this operation is invoked, it overwrites all existing entitlements, even the ones that are in the queue.

Request parameters

ParameterDetails
file

The multipart post parameter representing the entitlements file that has been exported out of the license manager.

Example

file=entitlements.json
appId

The identifier for the application for which the entitlements are being imported

Example

appId=arcgisprodesktop
f

The response format. The default response format is html.

Values: html | json | pjson

JSON Response syntax

{
   "itemId": "<itemId>",
   "appId": "<appId>",
   "current": {
     "orgEntitlements": {
        "maxUsers": <maxUsers>,
        "startDate": <startDate>,
        "startDateStr": "<startDateStr>",
        "entitlements": {
          "<feature1>": {
            "num": <number>,
            "license": "<license_string>"
          },
          "<feature2>": {
            "num": <number>,
            "license": "<license_string>"
          },
        }
     }
     "signature": "<signature>",
     "licenseManagerInfo": {
        "hostname": "<hostname>",
        "port": <port>
     }
   },
   "queue": [
     {
        "orgEntitlements": {
           "maxUsers": <maxUsers>,
           "startDate": <startDate>,
           "startDateStr": "<startDateStr>",
           "entitlements": {
              "<feature1>": {
                 "num": <number>,
                 "license": "<license_string>"
              },
              "<feature2>": {
                 "num": <number>,
                 "license": "<license_string>"
              },
           }
        },
        "signature": "<signature>",
        "licenseManagerInfo": {
           "hostname": <hostname>,
           "port": <port>
        }
     }
   ]
}

JSON Response example

{
  "itemId": "12345",
  "appId": "arcgisprodesktop",
  "current": {
    "orgEntitlements": {
      "maxUsers": 10,
      "startDate": 0,
      "startDateStr": "10-Sep-2014",
      "entitlements": {
        "desktopAdvN": {
           "num": 10,
           "license": "***"
        },
        "networkAnalystN": {
           "num": 5,
           "license": "***"
        }
      }
    },
    "signature": "***",
    "licenseManagerInfo": {
       "hostname": "licensemanager.domain.com",
       "port": 27000
    }
  },
  "queue": [
    {
      "orgEntitlements": {
         "maxUsers": 0,
         "startDate": 21432374576,
         "startDateStr": "10-Sep-2015",
         "entitlements": {
            "desktopAdvN": {
               "num": 0,
               "license": "***"
            },
            "networkAnalystN": {
               "num": 0,
               "license": "***"
            },
         }
      },
      "signature": "***",
      "licenseManagerInfo": {
         "hostname": "licensemanager.domain.com",
         "port": 27000
      }
    }
  ]
}