Python ArcGIS UserManager.search用法及代碼示例

本文簡要介紹 python 語言中 arcgis.gis.UserManager.search 的用法。

用法:

search(query=None, sort_field='username', sort_order='asc', max_users=100, outside_org=False, exclude_system=False, user_type=None, role=None)

返回：

適合查詢參數的 User 對象列表。

search 方法搜索門戶用戶，返回與指定查詢匹配的用戶列表。 search方法與advanced_search方法非常相似，但更加精致。

注意：

一些有助於了解的事情。

1. 查詢語法有很多特性在這裏無法充分說明。請參閱ArcGIS REST API Search Reference 以了解與此方法一起使用的搜索引擎的詳細信息。

2. 在不指定查詢參數的情況下進行搜索會返回組織中所有用戶的列表。

3. 大多數情況下，當您在ArcGIS Online 或您的門戶中搜索您想要在組織內搜索的用戶時。為方便起見，默認情況下，該方法會自動將您的組織 ID 附加到查詢中。如果您不希望 API 附加到您的查詢集 outside_org 為 True。如果將此函數與諸如 field=x 或 field=y 之類的 OR 子句一起使用，則在使用 outside_org 時應將其放入括號中。

Parameter	Description
query	可選字符串。查詢字符串。見上麵的注釋。傳遞 None 以獲取組織中所有用戶的列表。
sort_field	可選字符串。有效值可以是用戶名(默認值)或創建。
sort_order	可選字符串。有效值為 asc(默認值)或 desc。
max_users	可選整數。要返回的最大用戶數。默認值為 100。
outside_org	可選的布爾值。這控製是否在您的組織外部進行搜索。默認值為 False(僅在您的組織內搜索)。
exclude_system	可選的布爾值。控製是否返回內置係統帳戶。 True 表示不返回內置帳戶，而 False 表示它們是。
user_type	可選字符串。此參數允許按分配的類型過濾用戶。
role	可選字符串。指定角色標識。此參數允許根據 roleId 過濾用戶。

例子：

# Usage Example

>>> gis.users.search(query ="1234", sort_field = "username", max_users=20)