topic Re: ArcGIS API for Python GIS module - User object properties - check if user is disabled in ArcGIS API for Python Questions

ArcGIS API for Python GIS module - User object properties - check if user is disabled

DavidPike — Mon, 01 Mar 2021 13:46:12 GMT

Portal 10.6.1, running from IDE, GIS module - class arcgis.gis.User(gis, username, userdict=None)

I'm testing some Python API functionality to automate some listing of users, groups, access etc. and wanted to programmatically assess users which have had their access to the Portal disabled.

This is part of a larger aim, but at the moment I just want to be able to test if a user has been disabled or not, when that works, I'm happy with the rest of the coding.

using the API reference for the User class- https://developers.arcgis.com/python/api-reference/1.6.1/arcgis.gis.toc.html#user

the 'disabled' property when queried seems to return the correct True/False on my test accounts - although the documentation (also for the REST API) states - disabled - 'disables access to the organisation by the user')

I seem to be getting the correct boolean returned but I just wanted to be sure, as the documentation is a bit weak or misleading on this one (something I've found consistently across the API documentation).

trying the disable() method just to test it out also doesn't work.

#connect to portal, it connects fine gis = GIS(url, username, password) #search for user testeditor2 user = gis.users.search(query="username: testeditor2") #check if user is disabled print(user[0].disabled) #returns False #access testeditor2 from user list index 0 and try disable method user[0].disable() #returns #File "C:\Users\username\.conda\envs\py377\lib\urllib\request.py", line 649, #in http_error_default #raise HTTPError(req.full_url, code, msg, hdrs, fp)

Re: ArcGIS API for Python GIS module - User object properties - check if user is disabled

jcarlson — Mon, 01 Mar 2021 14:30:33 GMT

Running in 10.8.1, I also receive an error when attempting to call disable() on individual accounts. I am able to accomplish the task using the bulk operation arcgis.gis.UserManager.diable_users().

Oddly, checking user.disabled still returned "False" on my test accounts initially after the bulk action. It updated after a couple of minutes, as though the bulk action was asynchronous.

Once bulk-disabled, using enable() on a per-user basis worked just fine. I suspect this is a bug.

EDIT: Doesn't even work from the rest directory, either. (.../portal/sharing/rest/community/users/johndoe/disable)

Re: ArcGIS API for Python GIS module - User object properties - check if user is disabled

DavidPike — Mon, 01 Mar 2021 14:45:23 GMT

Glad it's not just me - are we in the same mindset that user.disabled is a boolean property for the user's disabled status - which has a poor description?

Is this the right syntax for the bulk op?

arcgis.gis.UserManager.disable_users(["testeditor2"])

Thanks J

Re: ArcGIS API for Python GIS module - User object properties - check if user is disabled

jcarlson — Mon, 01 Mar 2021 15:16:26 GMT

Yeah, disabled is a boolean property. I hadn't noticed the API docs before now, but it does look like they've got the method description listed next to the property. I put in an issue on their GitHub repo to get it fixed.

And yes, the syntax is either a list of username strings or a selection of users returned from something like UserManager.search().

Re: ArcGIS API for Python GIS module - User object properties - check if user is disabled

DavidPike — Mon, 01 Mar 2021 15:22:20 GMT

Cheers J

Re: ArcGIS API for Python GIS module - User object properties - check if user is disabled

jcarlson — Tue, 23 Mar 2021 00:18:48 GMT

@DavidPike one of the devs resolved the bug, said it should hit the API docs w/in the next week.

Re: ArcGIS API for Python GIS module - User object properties - check if user is disabled

DavidPike — Wed, 24 Mar 2021 10:14:07 GMT

Wow that's exceptionally fast. Thanks for your help and insight J.

Re: ArcGIS API for Python GIS module - User object properties - check if user is disabled

JohnMDye — Fri, 02 Jul 2021 18:40:38 GMT

@DavidPike, @AndrewChapkowski or @RohitSingh2 am I missing something here? user.disable() is clearly documented as a method that can be used to disable a user's login access: https://developers.arcgis.com/python/api-reference/arcgis.gis.toc.html#arcgis.gis.User.disable

Yet the following code:

users = [user for user in gis.users.search(query="username: testuser")] for user in users: print("Disabling " + user.fullName) user.disable()

results in

--------------------------------------------------------------------------- TypeError Traceback (most recent call last) <ipython-input-107-0490e44c9381> in <module> 1 users = [user for user in gis.users.search(query="username: testuser")] 2 for user in users: 3 print("Disabling " + user.fullName) ----> 4 user.disable() TypeError: 'bool' object is not callable

Re: ArcGIS API for Python GIS module - User object properties - check if user is disabled

jcarlson — Fri, 02 Jul 2021 18:56:40 GMT

What you're missing is that this thread was initially posted in March. It has since been resolved.

https://github.com/Esri/arcgis-python-api/issues/933

Re: ArcGIS API for Python GIS module - User object properties - check if user is disabled

JohnMDye — Tue, 06 Jul 2021 13:24:28 GMT

@jcarlson thanks for the response. I realize the thread was resolved, that was why I asked on the same thread because if its resolved, then I must be doing something wrong.

Last time I checked, properties are supposed to tell you something about an object's state, while python methods are supposed actually do something. What I don't understand is why there is a documented disable() method on the user object.

The disable method is documented in the latest version of the API documentation which I linked to above. Either I am doing something wrong in my code above, or this disable() method on the user object is not functional. I'm just trying to figure out which.