Get Entitlements

URL:
https://<licenses-url>/getEntitlements
Methods:
POST
Required Capability:
Administrator
Version Introduced:
10.3

Description

This operation returns the currently queued entitlements for a product, such as ArcGIS Pro or ArcGIS Navigator, and applies them when their start dates become effective. It's possible that all entitlements imported using the Import Entitlements operation are effective immediately and no entitlements are added to the queue. In this case, the operation returns an empty result.

Request parameters

ParameterDetails

appId

The identifier for the application for which the entitlements are queued.

Example

1
appId=arcgisprodesktop

f

The response format. The default response format is html .

Values: html | json | pjson

Example usage

Below is a sample POST request for getEntitlements :

1
2
3
4
5
6
POST /webadaptor/portaladmin/system/licenses/getEntitlements HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

appId=arcgisprodesktop&f=json

JSON Response syntax

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "itemId": "<itemId>",
  "appId": "<appId>",
  "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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "itemId": "12345",
  "appId": "arcgisprodesktop",
  "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
      }
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close