License

URL:: https://<root>/license
Methods:: GET
Operations:: Validate License, Import License, Populate License, Update License Manager, Release License, Get Future License
Version Introduced:: 10.7

Access requirements

Required privileges

The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Add Manage Licenses

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.

Learn how to generate a token

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 resource 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, and the version of ArcGIS Enterprise.

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://organization.example.com/<context>/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>
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "currentRegisteredMembers": 70,
  "maximumRegisteredMembers": 1400,
  "version": "11.4",
  "userTypes": [
    {
      "id": "IndoorsUserUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000,
      "currentRegisteredMembers": 1
    },
    {
      "id": "creatorUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000,
      "currentRegisteredMembers": 53
    },
    {
      "id": "editorUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000,
      "currentRegisteredMembers": 2
    },
    {
      "id": "GISProfessionalAdvUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000,
      "currentRegisteredMembers": 6
    },
    {
      "id": "GISProfessionalStdUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000,
      "currentRegisteredMembers": 2
    },
    {
      "id": "viewerUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000,
      "currentRegisteredMembers": 4
    },
    {
      "id": "fieldWorkerUT",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000,
      "currentRegisteredMembers": 2
    }
  ],
  "appBundles": [
    {
      "id": "urbanSuiteAB",
      "itemId": "ea1dec565b6f4afbb72501433962d8b1",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    }
  ],
  "apps": [
    {
      "id": "allsource",
      "itemId": "0a5e092dee574858a89afa4686386450",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "cityEngine",
      "itemId": "b2eaa28669e54ec08ff87e0ceec591df",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "stMapEU",
      "itemId": "fc02404cdda24f72842d34b28267d77a",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "Insights",
      "itemId": "f761dd0f298944dcab22d1e888c60293",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "BusinessAnlyst",
      "itemId": "4d31a12347be4006a6976e917e0a5a85",
      "maximumRegisteredMembers": 400,
      "expiration": 1761091200000
    },
    {
      "id": "stMapAP",
      "itemId": "f93928a375df44c283e9b6a4e86230bf",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "Navigator",
      "itemId": "9f017d9f94c74154aa7b2bcd2216687f",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "stMapLatA",
      "itemId": "e52fef7bd6974a64a7da07f1feae2f6d",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "stMapNA",
      "itemId": "2de31df5f72346c2a0505cd1f181ba6b",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "arcgisUrban",
      "itemId": "55eedfcd408443d39fba0e7079d8b49f",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "arcgisprodesktop",
      "itemId": "d4a332a0be784dd2be53cec0a35e0859",
      "maximumRegisteredMembers": 5800,
      "expiration": 1761091200000
    },
    {
      "id": "appstudiostd",
      "itemId": "43747254302e4c2590ac7a0d1c4e84a9",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "runtimeanalysis",
      "itemId": "27718bed7b4648fa96e31942535c8137",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "workforce",
      "itemId": "ff54441c792546379cfd3c8f87d9a0b6",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "stMapMEnA",
      "itemId": "1baa5c0610c141a8948f8ce3a7a54124",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "arcgisd2m",
      "itemId": "0b0e0497ace34206a67413d051530ded",
      "maximumRegisteredMembers": 400,
      "expiration": 1761091200000
    }
  ],
  "extensions": [
    {
      "id": "locsharing",
      "itemId": "f1f34442877843d387d7776bbf74bb94",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    },
    {
      "id": "advediting",
      "itemId": "bdfda9051e1e43f08af9afda9578efd8",
      "maximumRegisteredMembers": 200,
      "expiration": 1761091200000
    }
  ],
  "portalCapabilities": [
    {
      "id": "indoorsspaces",
      "expiration": 1761091200000
    },
    {
      "id": "indoorsmaps",
      "expiration": 1761091200000
    },
    {
      "id": "ips",
      "expiration": 1761091200000
    }
  ]
}