Python ArcGIS UserManager.create用法及代码示例

本文简要介绍 python 语言中 arcgis.gis.UserManager.create 的用法。

用法:

create(username, password, firstname, lastname, email, description=None, role=None, provider='arcgis', idp_username=None, level=2, thumbnail=None, user_type=None, credits=- 1, groups=None)

返回：

如果成功创建则为user，如果不成功则为 None。

create 操作用于在企业门户中预先创建内置或企业帐户，或在ArcGIS Online 组织帐户中预先创建内置用户。

注意：

只有管理员才能调用此方法。

成员的 user_type 确定可以分配给成员的默认 role。下表中注明了与每个角色兼容的用户类型(在user_type 部分中)。

要创建查看者帐户，请选择 role='viewer' 和 user_type='viewer'

Parameter	Description
username	必需的字符串。用户名，在 Portal 中必须是唯一的，长度为 6-24 个字符。
password	必需的字符串。用户的密码。它必须至少有 8 个字符。仅当提供者是 arcgis 时，这是必需的参数；否则，密码参数将被忽略。如果在ArcGIS Online 组织中创建帐户，可以将其设置为无，让用户通过单击通过电子邮件发送给他/她的链接来设置密码。当。。。的时候provider是企业, 密码是可选的。
firstname	必需的字符串。用户的名字
lastname	必需的字符串。用户的姓氏
email	必需的字符串。用户的电子邮件地址。这一点很重要。
description	可选字符串。用户帐户的说明。
thumbnail	可选字符串。用户图像的 URL。
role	可选字符串。用户帐户的 role。默认值为org_user。其他可能的值包括 org_publisher 、 org_admin 、 viewer 、 viewplusedit 或从 RoleManager 类的 all() 方法获取的自定义 role_id 值。
provider	可选字符串。帐户的提供者。默认值为 arcgis。另一个可能的值是企业。
idp_username	可选字符串。由企业用户存储存储的用户名。仅当提供者参数为企业时才需要此参数。
level	可选整数。帐户级别。 (ArcGIS Enterprise 版本 10.7 之前的版本。有关完整详细信息，请参阅User types, roles, and privileges。)可以在以下三个级别分配 GIS Professional user_type，这三个级别对应于 ArcGIS Pro 的三个许可证级别： GIS Professional Basic GIS Professional Standard GIS Professional Advanced
user_type	必需的字符串。帐户用户类型。这可以是创建者、查看者等。类型影响用户可以使用哪些应用程序以及他们可以在组织中执行哪些操作。 (ArcGIS Enterprise 10.7+ 和 ArcGIS Online。请参阅 User types, roles, and privileges 了解完整详细信息。) Members assigned the viewer role cannot create or share content, or perform analysis, and the viewer role is compatible with all user types. The Data Editor role viewplusedit is compatible with all user types except viewer. The org_user, org_publisher, and org_admin roles are compatible with the Creator, GIS Professional, Storyteller, and Insights Analyst user types. A complete list of user_type values can be obtained from the license_types property on the UserManager.
credits	可选浮点数。分配给用户的积分数。默认为无，表示无限制。 (10.7+)
groups	可选列表。一组组对象，为给定用户提供访问权限。 (10.7+)

例子：

# Usage Example: Assign custom role to a new user

>>> role_mgr = gis.users.roles

>>> for role in role_mgr.all():
>>>     print(f"{role.name}  {role.role_id}")

Viewer              iAAAAAAAAAAAAAAA
Data Editor         iBBBBBBBBBBBBBBB
CustomRole          bKrTCjFF9tKbaFk8

>>> user1 = gis.users.create(username='new_user_1',
                             password='<strong_password>',
                             firstname='New',
                             lastname='User',
                             email='namee@organization.com',
                             description='User with custom role assigned',
                             role='bKrTCjFF9tKbaFk8',
                             user_type='Creator')

>>> if user1: # setting the start_page of the newly created user
>>>     user1.landing_page = "organization"