ArcGIS REST API

Validate License

Description

The validateLicense operation is used to validate an input license file. Only valid license files can be imported into the 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 app information from the license file. If the file is invalid, the operation will fail and return an error message.

Request parameters

ParameterDetails
file

The portal license file.

listAdministratorUserTypes

Returns a list of user types that are compatible with the Administrator role. This identifies the user type(s) that can be assigned to the Initial Administrator Account when creating a portal.

Value: True | False

f

The response format. The default is html.

Value: html | json

Example usage

https://webadaptor.domain.com/webadaptorname/portaladmin/license/validateLicense

JSON response syntax

Sample response syntax for validateLicense with the listAdministratorUserTypes parameter set to False.

{"MyEsri": {
    "version": <version number>,
    "definitions": {
        "userTypes": [
            {
                "id": <user type ID>,
                "name": <user type name>,
                "description": <user type description>,
                "level": <level number>,
                "isEsriDefault": true
            },
            ...
        ],
        "appBundles": [
            {
                "name": <app bundle name>,
                "description": <bundle description>,
                "appBundleItemId": <bundle Id>
            },
            ...
        ]
    },
    "provision": {
        "userTypes": [    
            {
                "id": <user type Id>,
                "maxUsers": <number>,
                "startDate": <start date>,
                "apps": null
            },
            ...
        ],
        "appBundles": [],
        "apps": [
            {
                "id": <appId>,
                "maxUsers": <nunber>,
                "startDate": <start date>
            },
            ...
        ],
    }
}}

JSON response example

Response example for validateLicense with the listAdministratorUserTypes parameter set to False.

{"MyEsri": {
    "version": "10.7",
    "definitions": {
        "userTypes": [
            {
                "id": "creatorUT",
                "name": "Creator",
                "description": "Creator (formerly a Level 2 Named User)",
                "level": "2",
                "isEsriDefault": true
            },
            {
                "id": "GISProfessionalAdvUT",
                "name": "GIS Professional Advanced",
                "description": "GIS Professional Advanced",
                "level": "2",
                "isEsriDefault": true
            },
            {
                "id": "GISProfessionalStdUT",
                "name": "GIS Professional Standard",
                "description": "GIS Professional Standard",
                "level": "2",
                "isEsriDefault": true
            },
            {
                "id": "GISProfessionalBasicUT",
                "name": "GIS Professional Basic UT",
                "description": "GIS Professional Basic",
                "level": "2",
                "isEsriDefault": true
            },
            {
                "id": "viewerUT",
                "name": "Viewer",
                "description": "Viewer (formerly a Level 1 Named User)",
                "level": "1",
                "isEsriDefault": true
            },
            {
                "id": "fieldWorkerUT",
                "name": "Field Worker",
                "description": "Field Worker",
                "level": "11",
                "isEsriDefault": true
            }
        ],
        "appBundles": [
            {
                "name": "Essential Apps",
                "description": "Essential Apps",
                "appBundleItemId": "essentialAppsAB"
            },
            {
                "name": "Office Apps",
                "description": "Office Apps",
                "appBundleItemId": "officeAppsAB"
            },
            {
                "name": "Field Apps",
                "description": "Field Apps",
                "appBundleItemId": "fieldAppsAB"
            }
        ]
    },
    "provision": {
        "userTypes": [
            {
                "id": "creatorUT",
                "maxUsers": 5,
                "startDate": 1539907200000,
                "apps": null
            },
            {
                "id": "GISProfessionalAdvUT",
                "maxUsers": 5,
                "startDate": 1539907200000,
                "apps": null
            },
            {
                "id": "GISProfessionalStdUT",
                "maxUsers": 5,
                "startDate": 1539907200000,
                "apps": null
            },
            {
                "id": "GISProfessionalBasicUT",
                "maxUsers": 5,
                "startDate": 1539907200000,
                "apps": null
            },
            {
                "id": "viewerUT",
                "maxUsers": 5,
                "startDate": 1539907200000,
                "apps": null
            },
            {
                "id": "fieldWorkerUT",
                "maxUsers": 5,
                "startDate": 1539907200000,
                "apps": null
            }
        ],
        "appBundles": [],
        "apps": [
            {
                "id": "arcgisprodesktop",
                "maxUsers": 8,
                "startDate": 1539907200000
            },
            {
                "id": "arcgisprodesktop",
                "maxUsers": 0,
                "startDate": 1571443200000
            }
        ]
    }
}}

JSON response syntax

Sample response syntax for validateLicense with the listAdministratorUserTypes parameter set to True.

{"userTypes": [
    {"id": <userType Id>},
    {"id": <userType Id>},
    ...
]}

JSON response example

Response example for validateLicense with the listAdministratorUserTypes parameter set to True.

{"userTypes": [
    {"id": "creatorUT"},
    {"id": "GISProfessionalStdUT"},
    {"id": "GISProfessionalBasicUT"},
    {"id": "GISProfessionalAdvUT"}
]}