Skip To Content
ArcGIS Developers
Dashboard

Validate License

Description

The validateLicense operation is used to validate an input license file. Only valid license files can be imported into the ArcGIS Enterprise portal. If the provided file is valid, and the response format (f) is set to JSON, the operation will return user type, app bundle, and add-on license information.

Request parameters

ParameterDetails
file

(Required)

The portal license file.

listAdministratorUserTypes

(Required)

Returns a list of user types that are compatible with the Administrator role. This identifies the user types that can be assigned to the Initial Administrator Account when creating a portal. The default is false.

Values: true | false

f

The response format. The default response is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for validateLicense:

POST /context/admin/orgs/0123456789ABCDEF/licenses/validateLicense HTTP/1.1
Host: organization.domain.com
Content-Type: multipart/form-data; boundary=------boundary

------boundary
Content-Disposition: form-data; name="file"; filename=""
Content-Type: application/octet-stream

portalLicenseFile.json
------boundary
Content-Disposition: form-data; name="listAdministratorUserTypes"

false
------boundary
Content-Disposition: form-data; name="f"

pjson
------boundary
Content-Disposition: form-data; name="token"

Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis
------boundary--

JSON Response syntax

{
  "MyEsri": {
    "provision": {
      "extensions": [
        {
          "entitlements": [
            {
              "apiName": "<associated API>",
              "num": <maximum registered members allowed>
            }
          ],
          "maxUsers": <num>,
          "id": "<user type extension ID>",
          "startDate": <start date in epoch>
        },
        ...
      ],
      "appBundles": [
        {
          "maxUsers": <maximum registered members allowed>,
          "id": "<app ID>",
          "startDate": <start date in epoch>,
          "apps": null
        },
        ...
      ],
      "userTypes": [
        {
          "maxUsers": <maximum registered members allowed>,
          "id": "<user type ID>",
          "startDate": <start date in epoch>,
          "apps": null
        },
        ...
      ],
      "apps": [
        {
          "maxUsers": <maximum registered members allowed>,
          "id": "<app ID>",
          "startDate": <start date in epoch>
        },
        ...
      ]
    },
    "portalCapabilities": [],
    "version": "<version number>",
    "definitions": {
      "appBundles": [
        {
          "appBundleItemId": "<bundle ID>",
          "name": "<app bundle name>",
          "description": "<bundle description>"
        },
        ...
      ],
      "userTypes": [
        {
          "level": "<level number>",
          "name": "<user type name>",
          "description": "<user type description>",
          "id": "<user type ID>",
          "isEsriDefault": true
        },
        {
          "extensions": [
            {
              "entitlements": ["<entitlement>"],
              "id": "<entitlement ID>"
            },
            ...
          ],
          "level": "<level number>",
          "name": "<user type name>",
          "description": "<user type description>",
          "id": "<user type ID>",
          "isEsriDefault": true
        },
        ...
      ]
    }
  }
}

JSON Response example

{
  "MyEsri": {
    "provision": {
      "extensions": [
        {
          "entitlements": [
            {
              "apiName": "workflow",
              "num": 200
            }
          ],
          "maxUsers": 200,
          "id": "workflow",
          "startDate": 1612396800000
        },
        {
          "entitlements": [
            {
              "apiName": "workflow",
              "num": 0
            }
          ],
          "maxUsers": 0,
          "id": "workflow",
          "startDate": 1634688000000
        },
        {
          "entitlements": [
            {
              "apiName": "traceNetwork",
              "num": 200
            }
          ],
          "maxUsers": 200,
          "id": "traceNetwork",
          "startDate": 1612396800000
        },
        {
          "entitlements": [
            {
              "apiName": "traceNetwork",
              "num": 0
            }
          ],
          "maxUsers": 0,
          "id": "traceNetwork",
          "startDate": 1634688000000
        },
        {
          "entitlements": [
            {
              "apiName": "parcelFabric",
              "num": 200
            }
          ],
          "maxUsers": 200,
          "id": "parcelFabric",
          "startDate": 1612396800000
        },
        {
          "entitlements": [
            {
              "apiName": "parcelFabric",
              "num": 0
            }
          ],
          "maxUsers": 0,
          "id": "parcelFabric",
          "startDate": 1634688000000
        },
        {
          "entitlements": [
            {
              "apiName": "utilityNetwork",
              "num": 200
            }
          ],
          "maxUsers": 200,
          "id": "utilityNetwork",
          "startDate": 1612396800000
        },
        {
          "entitlements": [
            {
              "apiName": "utilityNetwork",
              "num": 0
            }
          ],
          "maxUsers": 0,
          "id": "utilityNetwork",
          "startDate": 1634688000000
        }
      ],
      "appBundles": [
        {
          "maxUsers": 200,
          "id": "essentialAppsAB",
          "startDate": 1612396800000,
          "apps": null
        },
        {
          "maxUsers": 0,
          "id": "essentialAppsAB",
          "startDate": 1634688000000,
          "apps": null
        },
        {
          "maxUsers": 200,
          "id": "officeAppsAB",
          "startDate": 1612396800000,
          "apps": null
        },
        {
          "maxUsers": 0,
          "id": "officeAppsAB",
          "startDate": 1634688000000,
          "apps": null
        },
        {
          "maxUsers": 200,
          "id": "fieldAppsAB",
          "startDate": 1612396800000,
          "apps": null
        },
        {
          "maxUsers": 0,
          "id": "fieldAppsAB",
          "startDate": 1634688000000,
          "apps": null
        }
      ],
      "userTypes": [
        {
          "maxUsers": 200,
          "id": "viewerUT",
          "startDate": 1612396800000,
          "apps": null
        },
        {
          "maxUsers": 0,
          "id": "viewerUT",
          "startDate": 1634688000000,
          "apps": null
        },
        {
          "maxUsers": 200,
          "id": "creatorUT",
          "startDate": 1612396800000,
          "apps": null
        },
        {
          "maxUsers": 0,
          "id": "creatorUT",
          "startDate": 1634688000000,
          "apps": null
        },
        {
          "maxUsers": 200,
          "id": "GISProfessionalAdvUT",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "GISProfessionalAdvUT",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "GISProfessionalStdUT",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "GISProfessionalStdUT",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "GISProfessionalBasicUT",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "GISProfessionalBasicUT",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "editorUT",
          "startDate": 1612396800000,
          "apps": null
        },
        {
          "maxUsers": 0,
          "id": "editorUT",
          "startDate": 1634688000000,
          "apps": null
        },
        {
          "maxUsers": 200,
          "id": "fieldWorkerUT",
          "startDate": 1612396800000,
          "apps": null
        },
        {
          "maxUsers": 0,
          "id": "fieldWorkerUT",
          "startDate": 1634688000000,
          "apps": null
        },
        {
          "maxUsers": 200,
          "id": "insightsAnalystUT",
          "startDate": 1612396800000,
          "apps": null
        },
        {
          "maxUsers": 0,
          "id": "insightsAnalystUT",
          "startDate": 1634688000000,
          "apps": null
        },
        {
          "maxUsers": 200,
          "id": "storytellerUT",
          "startDate": 1612396800000,
          "apps": null
        },
        {
          "maxUsers": 0,
          "id": "storytellerUT",
          "startDate": 1634688000000,
          "apps": null
        }
      ],
      "apps": [
        {
          "maxUsers": 5600,
          "id": "arcgisprodesktop",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "arcgisprodesktop",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "runtimeanalysis",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "runtimeanalysis",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "Drone2MapN",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "Drone2MapN",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "stMapEU",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "stMapEU",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "missionManager",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "missionManager",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "stMapAP",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "stMapAP",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "stMapLatA",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "stMapLatA",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "GeoPlanner",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "GeoPlanner",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "stMapNA",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "stMapNA",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "workforce",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "workforce",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "Navigator",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "Navigator",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "QuickCapture",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "QuickCapture",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "stMapMEnA",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "stMapMEnA",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "Insights",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "Insights",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "arcgisExcalibur",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "arcgisExcalibur",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "BusinessAnlyst",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "BusinessAnlyst",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "tracker",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "tracker",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "collector",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "collector",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "appstudiostd",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "appstudiostd",
          "startDate": 1634688000000
        },
        {
          "maxUsers": 200,
          "id": "survey123",
          "startDate": 1612396800000
        },
        {
          "maxUsers": 0,
          "id": "survey123",
          "startDate": 1634688000000
        }
      ]
    },
    "portalCapabilities": [
      {
        "endDate": 1634688000000,
        "id": "indoors",
        "startDate": 1612396800000
      }
    ],
    "version": "10.9",
    "definitions": {
      "appBundles": [
        {
          "appBundleItemId": "essentialAppsAB",
          "name": "Essential Apps",
          "description": "Essential Apps"
        },
        {
          "appBundleItemId": "officeAppsAB",
          "name": "Office Apps",
          "description": "Office Apps"
        },
        {
          "appBundleItemId": "fieldAppsAB",
          "name": "Field Apps",
          "description": "Field Apps"
        }
      ],
      "userTypes": [
        {
          "level": "1",
          "name": "Viewer",
          "description": "Viewer (formerly a Level 1 Named User)",
          "id": "viewerUT",
          "isEsriDefault": true
        },
        {
          "level": "2",
          "name": "Creator",
          "description": "Creator (formerly a Level 2 Named User)",
          "id": "creatorUT",
          "isEsriDefault": true
        },
        {
          "extensions": [
            {
              "entitlements": ["parcelFabric"],
              "id": "parcelFabric"
            },
            {
              "entitlements": ["utilityNetwork"],
              "id": "utilityNetwork"
            },
            {
              "entitlements": ["traceNetwork"],
              "id": "traceNetwork"
            }
          ],
          "level": "2",
          "name": "GIS Professional Advanced",
          "description": "GIS Professional Advanced",
          "id": "GISProfessionalAdvUT",
          "isEsriDefault": true
        },
        {
          "extensions": [
            {
              "entitlements": ["parcelFabric"],
              "id": "parcelFabric"
            },
            {
              "entitlements": ["utilityNetwork"],
              "id": "utilityNetwork"
            },
            {
              "entitlements": ["traceNetwork"],
              "id": "traceNetwork"
            }
          ],
          "level": "2",
          "name": "GIS Professional Standard",
          "description": "GIS Professional Standard",
          "id": "GISProfessionalStdUT",
          "isEsriDefault": true
        },
        {
          "level": "2",
          "name": "GIS Professional Basic",
          "description": "GIS Professional Basic",
          "id": "GISProfessionalBasicUT",
          "isEsriDefault": true
        },
        {
          "level": "11",
          "name": "Editor",
          "description": "Editor",
          "id": "editorUT",
          "isEsriDefault": true
        },
        {
          "level": "11",
          "name": "Field Worker",
          "description": "Field Worker",
          "id": "fieldWorkerUT",
          "isEsriDefault": true
        },
        {
          "level": "2",
          "name": "Insights Analyst",
          "description": "Insights Analyst",
          "id": "insightsAnalystUT",
          "isEsriDefault": true
        },
        {
          "level": "2",
          "name": "Storyteller",
          "description": "Storyteller",
          "id": "storytellerUT",
          "isEsriDefault": true,
          "supportsSignInOnlyFromUTApps": true
        }
      ]
    }
  }
}