Validate License

URL:
https://<root>/license/validateLicense
Methods:
POST
Required Capability:
Access allowed with the "Manage Licenses" privilege
Version Introduced:
10.7

Description

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

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 | pjson

JSON Response syntax

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{"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": {
    "extensions": [  //New at 10.8
      {
        "id": "<user type extension ID>",
        "maxUsers": <number>,
        "startDate": <start date in epoch>,
        "entitlements": [{
          "num": <maximum registered members allowed>,
          "apiName": "<associated API>"
        }]
      },
      ...
    ],
    "userTypes": [
      {
        "id": "<user type ID>",
        "maxUsers": <maximum registered members allowed>,
        "startDate": <start date in epoch>,
        "apps": null
      },
      ...
    ],
    "appBundles": [],
      "apps": [
        {
          "id": "<app ID>",
          "maxUsers": <maximum registered members allowed>,
          "startDate": <start date  in epoch>
        },
        ...
      ],
    }
  }
}

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

Use dark colors for code blocksCopy
1
2
3
4
5
{"userTypes": [
  {"id": <userType Id>},
  {"id": <userType Id>},
  ...
]}

JSON Response example

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
{"MyEsri": {
  "version": "10.8",
  "definitions": {
    "userTypes": [
      {
        "id": "creatorUT",
        "name": "Creator",
        "description": "Creator",
        "level": "2",
        "isEsriDefault": true
      },
      {
        "id": "GISProfessionalAdvUT",
        "name": "GIS Professional Advanced",
        "description": "GIS Professional Advanced",
        "level": "2",
        "isEsriDefault": true,
        "extensions": [  //New at 10.8
          {
            "id": "parcelFabric",
            "entitlements": ["parcelFabric"]
          },
          {
            "id": "utilityNetwork",
            "entitlements": ["utilityNetwork"]
          }
        ]
      },
      {
        "id": "GISProfessionalStdUT",
        "name": "GIS Professional Standard",
        "description": "GIS Professional Standard",
        "level": "2",
        "isEsriDefault": true,
        "extensions": [  //New at 10.8
          {
            "id": "parcelFabric",
            "entitlements": ["parcelFabric"]
          },
          {
            "id": "utilityNetwork",
            "entitlements": ["utilityNetwork"]
          }
        ]
      },
      {
        "id": "GISProfessionalBasicUT",
        "name": "GIS Professional Basic",
        "description": "GIS Professional Basic",
        "level": "2",
        "isEsriDefault": true
      },
      {
        "id": "insightsAnalystUT",
        "name": "Insights Analyst",
        "description": "Insights Analyst",
        "level": "2",
        "isEsriDefault": true
      },
      {
        "id": "fieldWorkerUT",
        "name": "Field Worker",
        "description": "Field Worker",
        "level": "11",
        "isEsriDefault": true
      },
      {
        "id": "editorUT",
        "name": "Editor",
        "description": "Editor",
        "level": "11",
        "isEsriDefault": true
      },
      {
        "id": "viewerUT",
        "name": "Viewer",
        "description": "Viewer (formerly a LV1 user)",
        "level": "1",
        "isEsriDefault": true
      }
    ],
    "appBundles": [
      {
        "name": "Field Apps",
        "description": "Field Apps",
        "appBundleItemId": "fieldAppsAB"
      },
      {
        "name": "Office Apps",
        "description": "Office Apps",
        "appBundleItemId": "officeAppsAB"
      },
      {
        "name": "Essential Apps",
        "description": "Essential Apps",
        "appBundleItemId": "essentialAppsAB"
      }
    ]
  },
  "provision": {
    "extensions": [  //New at 10.8
      {
        "id": "parcelFabric",
        "maxUsers": 200,
        "startDate": 1542672000000,
        "entitlements": [{
          "num": 200,
          "apiName": "parcelFabric"
        }]
      },
      {
        "id": "parcelFabric",
        "maxUsers": 0,
        "startDate": 1603225394000,
        "entitlements": [{
          "num": 0,
          "apiName": "parcelFabric"
        }]
      },
      {
        "id": "utilityNetwork",
        "maxUsers": 200,
        "startDate": 1542672000000,
        "entitlements": [{
          "num": 200,
          "apiName": "utilityNetwork"
        }]
      },
      {
        "id": "utilityNetwork",
        "maxUsers": 0,
        "startDate": 1603225394000,
        "entitlements": [{
          "num": 0,
          "apiName": "utilityNetwork"
        }]
      }
    ],
    "userTypes": [
      {
        "id": "creatorUT",
        "maxUsers": 200,
        "startDate": 1542672000000,
        "apps": null
      },
      {
        "id": "creatorUT",
        "maxUsers": 0,
        "startDate": 1603225394000,
        "apps": null
      },
      {
        "id": "GISProfessionalAdvUT",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "GISProfessionalAdvUT",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "GISProfessionalStdUT",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "GISProfessionalStdUT",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "GISProfessionalBasicUT",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "GISProfessionalBasicUT",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "insightsAnalystUT",
        "maxUsers": 200,
        "startDate": 1542672000000,
        "apps": null
      },
      {
        "id": "insightsAnalystUT",
        "maxUsers": 0,
        "startDate": 1603225394000,
        "apps": null
      },
      {
        "id": "editorUT",
        "maxUsers": 200,
        "startDate": 1542672000000,
        "apps": null
      },
      {
        "id": "editorUT",
        "maxUsers": 0,
        "startDate": 1603225394000,
        "apps": null
      },
      {
        "id": "viewerUT",
        "maxUsers": 200,
        "startDate": 1542672000000,
        "apps": null
      },
      {
        "id": "viewerUT",
        "maxUsers": 0,
        "startDate": 1603225394000,
        "apps": null
      },
      {
        "id": "fieldWorkerUT",
        "maxUsers": 200,
        "startDate": 1542672000000,
        "apps": null
      },
      {
        "id": "fieldWorkerUT",
        "maxUsers": 0,
        "startDate": 1603225394000,
        "apps": null
      }
    ],
    "appBundles": [
      {
        "id": "fieldAppsAB",
        "maxUsers": 200,
        "startDate": 1542672000000,
        "apps": null
      },
      {
        "id": "fieldAppsAB",
        "maxUsers": 0,
        "startDate": 1603225394000,
        "apps": null
      },
      {
        "id": "officeAppsAB",
        "maxUsers": 200,
        "startDate": 1542672000000,
        "apps": null
      },
      {
        "id": "officeAppsAB",
        "maxUsers": 0,
        "startDate": 1603225394000,
        "apps": null
      },
      {
        "id": "essentialAppsAB",
        "maxUsers": 200,
        "startDate": 1542672000000,
        "apps": null
      },
      {
        "id": "essentialAppsAB",
        "maxUsers": 0,
        "startDate": 1603225394000,
        "apps": null
      }
    ],
    "apps": [
      {
        "id": "arcgisprodesktop",
        "maxUsers": 5600,
        "startDate": 1542672000000
      },
      {
        "id": "arcgisprodesktop",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "appstudiostd",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "appstudiostd",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "collector",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "collector",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "workforce",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "workforce",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "BusinessAnlyst",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "BusinessAnlyst",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "Drone2MapN",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "Drone2MapN",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "survey123",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "survey123",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "Insights",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "Insights",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "tracker",
        "maxUsers": 200,
        "startDate": 1546992000000
      },
      {
        "id": "tracker",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "Navigator",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "Navigator",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "QuickCapture",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "QuickCapture",
        "maxUsers": 0,
        "startDate": 1603225394000
      },
      {
        "id": "arcgisRuntimeAdvanced",
        "maxUsers": 200,
        "startDate": 1542672000000
      },
      {
        "id": "arcgisRuntimeAdvanced",
        "maxUsers": 0,
        "startDate": 1603225394000
      }
    ]
  },
  "portalCapabilities": [{
    "id": "indoors",
    "startDate": 1542672000000,
    "endDate": 1603225394000
  }]
}}

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
{"userTypes": [
  {"id": "creatorUT"},
  {"id": "GISProfessionalStdUT"},
  {"id": "GISProfessionalBasicUT"},
  {"id": "GISProfessionalAdvUT"}
]}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.