ArcGIS REST API

License

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.

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 apps and app bundles.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | 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>
        } 
    ],
    "licenseManagerInfo": {
        "hostname": <"host information">,
        "port": <port>
    },
    "portalCapabilities": [{
        "id": <"portal capability ID">,
        "expiration": <expiration in epoch time>
    }]
}

JSON Response example

{
    "currentRegisteredMembers": 29,
    "maximumRegisteredMembers": 1400,
    "version": "10.7.1",
    "userTypes": [
        {
            "id": "creatorUT",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 8
        },
        {
            "id": "editorUT",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 2
        },
        {
            "id": "GISProfessionalAdvUT",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 8
        },
        {
            "id": "GISProfessionalBasicUT",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 2
        },
        {
            "id": "GISProfessionalStdUT",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 2
        },
        {
            "id": "viewerUT",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 5
        },
        {
            "id": "fieldWorkerUT",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 2
        }
    ],
    "appBundles": [
        {
            "id": "officeAppsAB",
            "itemId": "99d7956c7e824ff4ab27422e2a26c2b7",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000
        },
        {
            "id": "fieldAppsAB",
            "itemId": "c796f53163ce49dd92299e2bb83b20dd",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000
        },
        {
            "id": "essentialAppsAB",
            "itemId": "a9fd49108e8a4cb98f025a41cd97f2e2",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000
        }
    ],
    "apps": [
        {
            "id": "Insights",
            "itemId": "f761dd0f298944dcab22d1e888c60293",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000
        },
        {
            "id": "BusinessAnlyst",
            "itemId": "4d31a12347be4006a6976e917e0a5a85",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000
        },
        {
            "id": "Drone2MapN",
            "itemId": "3ba8dce822cb4f538cc9440912208bd4",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000
        },
        {
            "id": "Navigator",
            "itemId": "9f017d9f94c74154aa7b2bcd2216687f",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000
        },
        {
            "id": "GeoPlanner",
            "itemId": "f2f47e1641424fdd8a4ba2296d5e6ad8",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000
        },
        {
            "id": "tracker",
            "itemId": "54402634b3a849109c9ee1fad6907321",
            "maximumRegisteredMembers": 200,
            "expiration": 1574035200000
        },
        {
            "id": "survey123",
            "itemId": "d95d1f5dafcb461d97493a2d37ba9e78",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000
        },
        {
            "id": "collector",
            "itemId": "a6b6463248c147a0bf16cbb15075a554",
            "maximumRegisteredMembers": 200,
            "expiration": 1574121600000
        }
    ],
    "licenseManagerInfo": {
        "hostname": "webadaptorhost.domain.com",
        "port": 27000
    }
}