License

URL:: https://<root>/license
Methods:: GET
Required Capability:: Access allowed with either the "Manage Licenses" or "Add" privileges
Version Introduced:: 10.7

Description

The license resource returns license information for your organization. ArcGIS Enterprise portal requires a valid license to function correctly.

ArcGIS Enterprise enforces user type licensing. Members are assigned a user type, which determines the privileges that can be granted to the member through a role. Each user type may include access to specific apps. In addition, members can be assigned add-on applications and user type extensions.

This resourcee returns higher level licensing information, such as the total number of registered members that can be added, the current number of members in the organization, the version of ArcGIS Enterprise, and license manager information.

Request parameters

Parameter	Details
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample request URL used to access the license resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/portaladmin/license?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "currentRegisteredMembers": <number of registered members>,
  "maximumRegisteredMembers": <number of maximum registered members allowed>,
  "version": <"version number">,
  "userTypes": [
    {
      "id": <"user type ID">
      "maximumRegisteredMembers": <number of maximum registered members allowed>,
      "expiration": <expiration in epoch time>,
      "currentRegisteredMembers": <number of registered members>
    }
  ],
  "appBundles": [
    {
      "id": <"app bundle ID">,
      "itemId": <"app bundle item ID">,
      "maximumRegisteredMembers": <number of maximum registered members allowed>,
      "expiration": <expiration in epoch time>
    }
  ],
  "apps": [
    {
      "id": <"app ID">,
      "itemId": <"app item ID">,
      "maximumRegisteredMembers": <number of maximum registered members allowed>,
      "expiration": <expiration in epoch time>
    }
  ],
  "extensions": [
    {
      "id": "<extension ID>",
      "itemId": "<item ID>",
      "maximumRegisteredMembers": <number of maximum registered members allowed>,
      "expiration": <expiration in epoch time>
    }
  ],
  "portalCapabilities": [
    {
      "id": <"portal capability ID">,
      "expiration": <expiration in epoch time>
    }
  ],
  "licenseManagerInfo": {
    "hostname": <"host information">,
    "port": <port>
  }
}

JSON Response example

Use dark colors for code blocksCopy
{
  "currentRegisteredMembers": 37,
  "maximumRegisteredMembers": 2200,
  "version": "10.8",
  "userTypes": [
    {
      "id": "basicUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 2
    },
    {
      "id": "liteUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 2
    },
    {
      "id": "creatorUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 8
    },
    {
      "id": "editorUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 2
    },
    {
      "id": "GISProfessionalAdvUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 5
    },
    {
      "id": "GISProfessionalBasicUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 2
    },
    {
      "id": "standardUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 6
    },
    {
      "id": "GISProfessionalStdUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 2
    },
    {
      "id": "insightsAnalystUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 2
    },
    {
      "id": "viewerUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 4
    },
    {
      "id": "fieldWorkerUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000,
      "currentRegisteredMembers": 2
    }
  ],
  "appBundles": [
    {
      "id": "officeAppsAB",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "fieldAppsAB",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "essentialAppsAB",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    }
  ],
  "apps": [
    {
      "id": "Insights",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "BusinessAnlyst",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "Drone2MapN",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "Navigator",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "survey123",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "arcgisRuntimeAdvanced",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "collector",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "QuickCapture",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "arcgisprodesktop",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 5600,
      "expiration": 1603225394000
    },
    {
      "id": "appstudiostd",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "tracker",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "workforce",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    }
  ],
  "extensions": [
    {
      "id": "parcelFabric",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    },
    {
      "id": "utilityNetwork",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 200,
      "expiration": 1603225394000
    }
  ],
  "portalCapabilities": [{
    "id": "indoors",
    "expiration": 1603225394000
  }],
  "licenseManagerInfo": {
    "hostname": "machine.ags.esri.com",
    "port": 27000
  }
}