topic Re: How to change the User Type License using REST API? in ArcGIS Enterprise Portal Questions

How to change the User License Type using REST API?

Thomas_Z2 — Thu, 02 Jun 2022 19:05:41 GMT

How can I change the User License Type using the REST API? I searched unsuccessful for an endpoint, I suspect there should be something similar like these endpoints:

Re: How to change the User Type License using REST API?

JohnPlunkett — Thu, 02 Jun 2022 02:39:59 GMT

Is this what you are after?

portal/sharing/rest/portals/0123456789ABCDEF/updateUserRole

Re: How to change the User Type License using REST API?

Thomas_Z2 — Thu, 02 Jun 2022 12:56:49 GMT

Thank you @JohnPlunkett but I was looking for this:

/portals/self/updateUserLicenseType

and it looks like it exists but it is undocumented.

Here my findings in case someone else has a similar use case:

https://gist.github.com/moosetraveller/a2e8728ecad7a2e5d1d5bd2679dfdcae

Re: How to change the User Type License using REST API?

Marc_Graham — Sun, 26 Feb 2023 22:50:29 GMT

Thanks so much for updating this thread with what you found. 😀

Re: How to change the User Type License using REST API?

GarethFinney1 — Tue, 23 May 2023 00:28:11 GMT

Hi there @Thomas_Z2

I saw your posting on the updateUserLicenseType Rest API call, and was wondering if you would mind sharing a code snippet of sorts to help me out here. I've been trying to find the way to update a user on the fly via the back-end, and this seems to be the way to do it - and as you've mentioned, Esri have not really documented anything about it!

I've tinkered with the url request ../arcgis/sharing/rest/portals/self/updateUserLicenseType?... but I'm yet to find a valid url that actually works.

I'll also take a look at the Python approach you've mentioned, but I'd rather hit it with a Rest call to be honest.

Any help truly appreciated (in either Rest, or Python cases)

thanks in advance

Gareth

Re: How to change the User Type License using REST API?

Marc_Graham — Tue, 23 May 2023 00:43:56 GMT

Hi Gareth,

I have created a workflow in FME that allows users to "check out" or "return" a license without having to ask an administrator. The workflow requires us to update the role and the license type in two steps. there are two options - if the user checks out a license I set their named user to fieldWorkerUT and the corresponding custom role and if the user returns a license I set them to viewerUT and the corresponding custom viewer role.

First update License Type:

Request URL: $(arcgis_portal_url)/$(arcgis_portal_webadaptor_context)/sharing/rest/portals/0123456789ABCDEF/updateUserLicenseType

Method: POST

Parameters:

token: token
users: $(portal_username)
f: pjson
userLicenseType: $(new_user_type)

new_user_type = fieldWorkerUT or viewerUT

Second update User Role:

URL: $(arcgis_portal_url)/$(arcgis_portal_webadaptor_context)/sharing/rest/portals/0123456789ABCDEF/updateUserRole

Method: POST

Parameters:

token: token
users: $(portal_username)
f: pjson
role: $(new_role)

new_role = 7Wqt2kdDEMSska9w or 3Fg8KwpdZknhNZE6 depending upon which one matches the license type that was selected first.

I hope this helps,

Marc

Re: How to change the User Type License using REST API?

GarethFinney1 — Tue, 23 May 2023 00:51:31 GMT

Hi Marc,

thanks for the speedy reply - much appreciated. I'll give it a try, but I'm actually starting to think I may need to update the portal, from 10.7.x I can't see the /updateUserLicenseType method on the /arcgis/sharing/rest/portals/self endpoint. Can you please confirm this, if running a newer version of Portal?

thanks again

Gareth

Re: How to change the User Type License using REST API?

Marc_Graham — Tue, 23 May 2023 01:04:49 GMT

EDIT: Oh I see that is a slightly different endpoint in the documentation. I still confirmed it is there at 10.7 in our old portal:

It should be there - according to the docs it was introduced at 10.7: https://developers.arcgis.com/rest/users-groups-and-items/user-license-types.htm

I can confirm that on our deprecated 10.7 portal it is there.

Re: How to change the User Type License using REST API?

Marc_Graham — Tue, 23 May 2023 01:06:20 GMT

it doesn't appear to be documented anywhere except for in relation to webhooks:

https://www.esri.com/content/dam/esrisites/en-us/events/conferences/2020/federal-gis/administering-arcgis-enterprise.pdf

https://developers.arcgis.com/rest/users-groups-and-items/create-webhooks.htm

Re: How to change the User Type License using REST API?

GarethFinney1 — Tue, 23 May 2023 01:10:06 GMT

yeah cool.. I see it now - just needed to scroll down to the bottom of the page - doh!

thanks for your help on this, much appreciated