ArcGIS REST API

License

Description

The Enterprise portal requires a valid license to function correctly. This resource returns information for user types that are licensed 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 an be granted to the member through a role. Each user type may include access to specific apps and app bundles.

The license information returned for the organization includes the total number of registered members that can be added, the current number of members in the organization and the Portal for ArcGIS version. For each user type, the license information includes the ID, the maximum number of registered members that can be assigned, the number of members currently assigned the license and the expiration, in epoch time. In addition, this resource provides access to the Validate License, Import License, Populate License, Update License Manager, and Release License operations.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json

JSON response syntax

{
    "currentRegisteredMembers": <number of registered users>,
    "maximumRegisteredMembers": <maximum number of registered users>,
    "version": <version number>
    "userTypes": [
        {
            "userTypeId": <user type Id>,
            "maximumRegisteredMembers": <maximum number of registered users>,
            "expiration": <expiration in epoch time>,
            "currentRegisteredMembers": <number of registered members>
        },
        ...
    ],
    "appBundles": [],
    "apps": [],
    "licenseManagerInfo": {
        "hostname": <hostname>,
        "port": <port number>
    }
}

JSON response example

{
    "currentRegisteredMembers": 28,
    "maximumRegisteredMembers": 500,
    "version": "10.7.0"
    "userTypes": [
        {
            "userTypeId": "creatorUT",
            "maximumRegisteredMembers": 50,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 1
        },
        {
            "userTypeId": "editorUT",
            "maximumRegisteredMembers": 50,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 4
        },
        {
            "userTypeId": "GISProfessionalAdvUT",
            "maximumRegisteredMembers": 50,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 7
        },
        {
            "userTypeId": "GISProfessionalBasicUT",
            "maximumRegisteredMembers": 50,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 1
        },
        {
            "userTypeId": "GISProfessionalStdUT",
            "maximumRegisteredMembers": 50,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 2
        },
        {
            "userTypeId": "viewerUT",
            "maximumRegisteredMembers": 50,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 5
        },
        {
            "userTypeId": "fieldWorkerUT",
            "maximumRegisteredMembers": 50,
            "expiration": 1574121600000,
            "currentRegisteredMembers": 8
        }
    ],
    "appBundles": [],
    "apps": [],
    "licenseManagerInfo": {
        "hostname": "changeme.mydomain.com",
        "port": 27000
    }
}