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)