License

• URL:https://<portaladmin-url>/license
  
• Operations:Validate License, Import License, Populate License, Update License Manager, Release License, Get Future License
• Required Capability:Default administrator role | Manage licenses privilege | Add privilege
• Version Introduced:10.7

Description

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

Starting at 10.7, the Enterprise portal 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, starting at 10.8, user type extensions.

The License API returns higher level information such as the total number of registered members that can be added, the current number of members in the organization, the Enterprise portal version, and license manager information. This API returns detailed license information for your organizations user types and add-on licenses.

Request parameters

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

Example usage

Below is a sample request URL for the license resource:

https://machine.domain.com/webadaptor/portaladmin/license?f=json

JSON Response syntax

{
  "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

{
  "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": "GeoPlanner",
      "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
  }
}