您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
用户需要先添加到系统中,然后才能开始使用您的开发者服务门户。默认情况下,任何用户都可以通过在门户菜单中选择“注册”链接,在开发者门户上注册。然后,系统会自动对用户的账号进行身份验证,并为用户分配经过身份验证的用户角色。
您可以自定义开发者门户,以便只有具有管理员权限的用户才能添加用户账号。在这种情况下,管理员需要手动添加用户账号。管理员可能还需要为内部开发者手动添加用户账号,或者代表客户添加开发者。
添加用户账号后,管理员可以向该用户账号分配角色,从而将该角色的权限与该账号相关联。此外,管理员还可以管理现有用户账号,包括修改账号的用户个人资料、删除账号、屏蔽或取消屏蔽账号,或向账号分配新角色。管理员还可以指定在账号被取消后,用户账号及其关联内容(例如博文条目和论坛帖子)会发生什么情况。
开发者门户可以在事件发生时自动向用户发送电子邮件。例如,当添加用户、屏蔽账号或取消账号时,该门户可以发送电子邮件。在管理用户时,您可以控制这些电子邮件的内容和格式。如需了解详情,请参阅配置电子邮件。
如需了解如何管理注册工作流;自定义注册电子邮件;禁止 IP 地址注册;以及创建、管理和屏蔽用户账号,请观看此视频。
控制哪些人可以注册账号
默认情况下,任何用户都可以通过点击“注册”链接在开发者门户中创建账号。
如要控制哪些人可以注册账号,请执行以下操作:
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中,依次选择配置 > 用户 > 账号设置。系统随即会打开“账号设置”页面。
- 在“注册和取消”部分中,点击“谁可以注册账号”下方的相应注册选项。选项包括:
- 仅限管理员:只有管理员可以注册用户账号。
- 访问者:任何人都可以注册。这是默认值。
- 访问者,但需要管理员批准:任何人都可以注册,但需要管理员授权账号。
- 选中或清除在访问者创建账号时要求进行电子邮件验证对应的复选框。如果此复选框未选中,开发者在注册后会立即登录该门户。如果选中此选项,用户会收到一封电子邮件,用于验证其电子邮件地址,然后才能登录。
- 点击 Save configuration(保存配置)。
添加用户账号
根据您的门户配置,管理员必须手动添加用户,或者用户可以通过在开发者门户上选择“注册”链接来自行添加。
手动添加用户账号
如需手动添加用户账号,请执行以下操作:
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中,依次选择人员 > 添加用户。
- 在“名字”“姓氏”“用户名”“电子邮件地址”和“密码”字段中输入用户的相关内容,并表明您接受用户协议。
- (可选)为用户设置状态和角色。
- 选择通知用户新账号,以便系统自动向用户发送电子邮件。
- 点击创建账号。
通过开发者门户注册用户
如需通过开发者门户注册用户,请执行以下操作:
- 用户在开发者门户首页上选择注册。
- 系统随即会显示注册页面。
- 用户输入所需信息,然后选择创建新账号。
创建新账号后,系统会根据新账号注册设置向用户自动发送欢迎电子邮件。
自动在有新用户注册时通知管理员
默认情况下,当新用户在门户上注册时,会收到一封电子邮件。如需了解详情,请参阅配置电子邮件。
不过,默认情况下,当有新用户注册时,门户管理员不会收到通知。例如,如果您将门户配置为需要管理员批准才能激活新用户的账号,则需要确保在创建新账号时通知管理员。否则,用户账号将保持闲置状态。
如需在有新用户注册账号时通知管理员,请执行以下操作:
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中,依次选择配置 > 用户 > 管理员通知。
- 在用户提醒下,指定接收电子邮件的用户。您可以将其转给:
- 发送到自定义电子邮件地址
- 发送给特定角色。如果您选择此选项,则可能需要创建一个新角色。否则,如果您选择“管理员”等角色,则所有管理员都会收到电子邮件,但该电子邮件可能并不适用于所有管理员。
- 二者都有
- 修改邮件主题和正文。
- 选择在以下情况下发送电子邮件:
- 在创建用户时接收电子邮件。
- 在创建和更新用户时接收电子邮件。
- 点击 Save configuration(保存配置)。
管理用户账号
管理员可以管理用户账号,以设置用户信息、重置密码、激活账号、取消或暂停账号,以及执行其他任务。
如需修改用户账号的用户个人资料,请执行以下操作:
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中,选择用户。
- 您可以使用页面顶部的过滤区域,根据特定用户名、电子邮件地址、状态或权限过滤显示的用户。默认情况下,系统会为这些过滤条件选择“任何”,在这种情况下,页面上会列出所有用户。
- 在用户账号的“用户名”行中,点击修改。这会打开用户个人资料的可修改视图。
- 酌情更改用户个人资料数据。
- 点击保存。
添加人机识别系统
您可以通过启用 Drupal CAPTCHA 和 reCAPTCHA 模块,向登录页面和其他页面添加 CAPTCHA 验证。reCAPTCHA 模块添加了对免费 Google reCAPTCHA 服务的支持。
Drupal 支持其他 CAPTCHA 模块(例如图片 CAPTCHA),您也可以在门户上使用这些模块。
视频:观看有关在开发者门户中启用 CAPTCHA 的简短视频。
如需启用 reCAPTCHA,请执行以下操作:
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 从 Drupal 菜单中选择模块。
- 同时启用 CAPTCHA 和 reCAPTCHA 模块。
- 请访问 https://www.google.com/recaptcha/intro/index.html,注册 Google reCAPTCHA 密钥。
- 在 Drupal 菜单中,依次选择配置 > 用户 > CAPTCHA > reCAPTCHA。
- 输入公钥(Google 网站键)和私钥(Google 密钥)。您可以将其余设置保留为默认值。
- 依次选择配置 > 用户 > CAPTCHA,设置您希望 reCAPTCHA 表单显示的位置。默认情况下,此字段会显示在登录表单和用户注册表单中。
- 在此页面中,为每个表单设置质询类型。
- 保存更改。
添加“条款及条件”页面
您可以向开发者门户添加“条款及条件”页面,用户必须在登录时接受这些条款及条件,然后才能访问该门户。如果您日后更改“条款及条件”页面,用户在下次登录时必须接受更新后的条款及条件。
实现“条款及条件”页面时,需要使用 Drupal 法律模块。该模块提供了一种灵活的方式来创建“条款及条件”页面、跟踪条款及条件的修订历史记录,以及跟踪已接受条款及条件的用户。
创建后,“条款及条件”页面的网址为 <siteURL>/legal
。
如需启用“法律”模块,请执行以下操作:
- 以具有管理员权限的用户身份登录门户。
- 在 Drupal 管理菜单中,选择模块。系统随即会显示所有已安装的 Drupal 模块的列表。
- 向下滚动页面,然后选中法律模块旁边的复选框。
- 点击 Save configuration(保存配置)。
如需 创建“条款及条件”页面,请执行以下操作:
- 以具有管理员权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择 Configuration > People > Legal。
此菜单项仅在启用法律模块后才会显示。页面顶部的“最新版本/修订版”下方会显示当前的条款及条件。如果您尚未定义条款及条件,此区域将为空。您可以在“创建新版本/译文”下方的“条款及条件”区域中创建新版本。 - 在“条款及条件”区域中输入您的服务条款。
- 选择要在网页上显示条款及条件的方式:滚动条、滚动条(CSS)、HTML 文本或网页链接。
- (可选)添加其他复选框和一个用于描述最新更改的文本区域。
- 选择预览可在“最新版本/修订版”下方的“使用条款及条件”区域预览条款及条件,或选择保存以保存条款及条件。
如需监控条款及条件的变更和接受情况,请执行以下操作:
- 以具有管理员权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择 Configuration > People > Legal。
- 选择条款及条件历史记录标签页,查看条款及条件的修订历史记录。
- 选择已接受标签页,查看已接受各个版本条款及条件的用户列表。
在用户登录时重定向
默认情况下,当用户登录门户时,会被定向到显示其信息(例如名字和姓氏)的页面。或者,您也可以使用 Drupal Rules 模块添加规则,以自动将用户重定向到其他网页。例如,您可以将用户重定向到列出其所有应用的页面,也可以重定向到门户首页。
您必须先确保已启用所有必要的 Drupal 模块,然后才能创建重定向规则。
启用必要的 Drupal 模块:
- 以具有管理员权限的用户身份登录门户。
- 在 Drupal 管理菜单中,选择模块。
- 启用以下模块(如果尚未启用):
- “me”别名(显示在模块列表的顶部,而非与所有其他模块一样按字母顺序显示)
- LoginToboggan
- 规则
- 规则界面
- 点击 Save configuration(保存配置)。
您可能会看到系统自动启用其他必需的模块。
创建登录重定向规则:
- 以具有管理员权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择 Configuration > Workflow > Rules。
- 在“规则”页面上,选择 + 添加新规则。
- 指定规则的名称:登录重定向。
- (可选)将某个标记指定为“登录”。
- 在“对事件做出响应”下拉框中,依次选择用户 > 用户已登录。
- 选择保存
系统随即会显示“修改回应规则”页面。您已在前面的步骤中设置该事件,因此“事件”下方应显示“用户已登录”。为此规则将“条件”留空。 - 在“操作”下,选择 + 添加操作。
- 在下拉菜单中依次选择系统 > 页面重定向。
“添加新操作”页面会更改其布局,以便您指定重定向网址。 - 在“Value”(值)下,指定 user/[account:uid]/apps。
[account:uid] 是与用户的门户 ID 对应的替换模式。如需查看替换模式的完整列表,请选择“值”输入框下的“替换模式”。 - 点击保存,返回“修改回应规则”页面。该页面应如下所示:
- 点击保存更改。
如需日后修改该规则,请从“配置”页面中选择“规则”,然后从规则列表中选择“登录重定向”。
现在,当用户登录时,系统会将其重定向到列出其所有应用的页面。如果您想将用户重定向到门户的首页,请修改您在上一步(第 11 步)中设置的“值”,以指定门户首页的网址。例如,http://dev-myCompany.devportal.apigee.io/。
设置用户角色和权限
角色定义了一组特定权限,可让用户执行特定活动。 您可以通过向用户分配具有必要权限的角色,向用户或用户群组授予特权。管理员可以在开发者门户上管理角色,包括为角色设置权限。
默认情况下,Drupal 会创建两个角色:
- 匿名用户 - 未登录的任何用户的角色。系统会阻止匿名用户执行大多数操作。
- 已验证用户 - 分配给所有用户的默认角色。您可以为用户分配其他角色,但他们始终会被分配此角色。
此外,Apigee 还添加了管理员角色。将用户分配到管理员角色,为其授予对门户的管理权限。
通常,您会向门户添加角色,以便根据不同的用户类型区分权限。用户可以担任单个角色,也可以担任多个角色。系统会将所有用户分配到“经过身份验证的用户”角色,但如果您想将用户分配到其他角色,则必须向门户添加逻辑或手动执行角色分配。
如需查看所有角色和权限,请执行以下操作:
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中,依次选择人员 > 权限 > 角色。
如需添加新角色,请执行以下操作:
- 依次选择人员 > 权限 > 角色。
- 在“用户”页面上“添加角色”按钮上方的文本框中输入新角色名称。
- 点击添加角色。
如需修改角色,请执行以下操作:
- 依次选择人员 > 权限 > 角色。
- 在“用户”页面上,点击相应角色所在行的修改角色。
- 根据需要更改角色名称。
- 点击保存。
如需删除角色,请按以下步骤操作:
- 依次选择人员 > 权限 > 角色。
- 在“用户”页面上,点击相应角色所在行的修改角色。
- 点击删除角色。
如需向角色添加用户,请执行以下操作:
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中,选择用户。
- 在用户账号的“用户名”行中,点击修改。这会打开用户个人资料的可修改视图。
- 根据需要为用户选择所有角色。
- 点击保存。
如需更改角色的权限,请执行以下操作:
- 依次选择人员 > 权限 > 角色。
- 点击“人员”页面上的权限标签页。
系统会显示一个角色和权限表格。表格中的对勾标记表示哪些权限分配给了哪些角色。
- 勾选或取消选中复选框,分别授予或撤消与该角色关联的权限。
例如,若要禁止经过身份验证的用户创建或删除应用,请向下滚动到权限表的 DevConnet 开发者应用部分,然后取消选中经过身份验证的用户下方的创建开发者应用和删除开发者应用对应的复选框。 - 点击保存权限。
自定义用于注册用户的表单字段
当用户在门户上注册账号时,门户会显示默认的注册页面,其中包含“名字”“姓氏”“用户名”“电子邮件地址”和“密码”字段。 作为 API 提供方,您可能需要修改此表单,以提示用户提供公司名称、邮寄地址或其他信息等其他信息。您可以通过该门户向此表单添加新字段。这些字段可以是:
- 必填或可选
- 通过不同的 HTML 元素(例如文本框、单选按钮、复选框等)显示
- 可设置为显示在表单的任意位置
如需了解如何自定义开发者门户提供的用户注册表单,请观看此视频。
例如,您可以为“公司名称”添加必填字段,或为“电话号码”添加可选字段。或者,您也可以添加多个字段,包括可选字段和必填字段。
下图显示了添加到表单中的公司名称必填字段:
作为门户管理员,您可以通过以下方式查看和修改用户的信息(包括任何自定义字段):
- 在门户的 Drupal 管理菜单中选择用户。
- 在与用户名称相对应的行中选择修改。
作为管理员,您可以通过此方式访问用户信息。
默认情况下,当您向表单添加新字段时,字段值不会上传到 Edge。 不过,您可以将门户配置为在用户提交表单时上传这些值。也就是说,您可以在 Edge 上查看这些字段,也可以使用 Edge 管理 API 通过脚本访问这些字段。
例如,如需在 Edge 管理界面中查看新的表单字段,请依次前往发布 > 开发者,然后选择用户名。新字段值会显示在页面的“自定义属性”区域下,名称与字段的内部名称相对应:
如需向用户注册表单添加字段,请执行以下操作:
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中,依次选择配置 > 用户 > 账号设置。
- 选择页面顶部的管理 字段按钮。
- 向下滚动页面,找到“添加新字段”区域:
- 配置该字段。例如,对于上方显示的公司名称字段,请使用以下设置:
- 选择保存。
- 由于这是文本字段,系统会提示您指定字段的长度上限。
- 输入最大长度,然后选择保存字段设置。
- 系统会显示一个新页面,您可以在其中为该字段指定其他信息,包括:
- 用于将此字段设为必填字段的复选框。
- 用于指定要显示该字段的复选框。
- 可选的帮助文本,会以弹出式窗口的形式显示在表单中。
- 其他设置。
- 请务必选中复选框,将此字段设为必填字段。
- 如果您在此页面上进行任何更改,请保存设置。
您可能需要清除浏览器缓存,表单中才会显示新字段。
如需对表单上的属性进行重新排序,请执行以下操作:
默认情况下,新建的必填字段会显示在“姓氏”字段后面。可选字段显示在表单底部的密码字段后面。
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中,依次选择配置 > 用户 > 账号设置。
- 选择页面顶部的管理字段按钮。
- 选择“标签”列下的加号 + 符号,然后将该字段拖动到您希望在表单中显示该字段的位置。
- 保存更改。
在 Edge 中将表单字段值保存为自定义开发者属性
您可以在 Edge 中将表单字段值保存到自定义开发者属性。您可以查看和管理开发者的自定义属性,如管理应用开发者中所述。
保存自定义开发者属性后,您可以使用 Access Entity 政策,例如根据自定义属性值启用动态行为。
如需了解如何将表单字段值保存为自定义开发者属性,请观看此视频。
如需在 Edge 中将字段值保存为自定义开发者属性,请执行以下操作:
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中,依次选择 Configuration > Dev Portal > Developer Attributes。
系统会显示可用字段的列表。 - 选择您要在 Edge 中将其保留为属性的字段,例如“公司名称”。
- 选中在 Edge 中将此字段保留为属性对应的复选框。
- 指定 Edge 属性名称。这是“自定义属性”表中用户对应的“名称”列中显示的名称。
- 指定空字段的行为
- 如果您想将值转换为布尔值,并在发送到 Edge 之前将其转换为 true 或 false 字符串,请选择将值转换为 true|false 字符串。
- 点击 Save configuration(保存配置)。
现在,当用户提交表单时,系统会将自定义属性上传到 Edge。如果您是管理员,并且想要更改自定义字段的值,请通过门户(而非 Edge)进行更改。
在用户注册新账号时创建默认应用
您可以在用户注册新的门户账号时自动创建默认应用。当用户首次登录时,该应用会显示在“我的应用”页面上。根据为用户角色分配的权限,您可以允许用户添加其他应用,也可以将此应用设为用户可用的唯一应用。
您可以完全控制默认应用的属性,包括:
- 应用包含的 API 产品
- 应用状态:待处理或已批准
- 回调网址(如有必要)
- 应用应用的自定义参数
您可以使用 Drupal Rules 模块创建规则,以控制默认应用的创建。借助规则,您可以定义在门户上发生事件时执行的操作。在此场景中,事件是用户在门户上注册账号。此操作是为用户创建默认应用。
自定义用于注册应用的表单字段部分介绍了如何添加用于配置应用的自定义属性。这些属性可以是可选属性,也可以是必需属性,具体取决于您对它们的定义方式。如果您创建了任何自定义应用属性,则可以在定义默认应用时设置这些属性。
启用 Drupal 规则模块:
- 以具有管理员权限的用户身份登录门户。
- 在 Drupal 管理菜单中选择模块
- 启用以下模块(如果尚未启用):
- “me”别名(显示在模块列表的顶部,而非与所有其他模块一样按字母顺序显示)
- LoginToboggan
- 规则
- 规则界面
- 点击 Save configuration(保存配置)。
您可能会看到系统自动启用其他必需的模块。
创建规则以添加默认应用:
- 以具有管理员权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择配置 > 工作流 > 规则。
- 选择 + 添加新规则按钮。
- 指定规则的名称。
- (可选)在标记字段中指定“登录”,或您要用于对规则进行分类的任何其他标记。
- 在“对事件做出响应”下拉框中,依次选择用户 > 保存新用户账号后。
- 选择保存。
系统随即会显示规则修改页面。您已在前面的步骤中设置事件,因此“事件”下方应显示“保存新用户账号后”。 - 为此规则将条件留空。
- 在操作下,选择 + 添加操作。
- 在下拉菜单中,依次选择 Devconnect > Create a developer application。
“添加新操作”页面会更改其布局,以便您配置应用。 - 在API 名称下,指定默认应用的名称。例如,使用 [account:field_last_name] 应用。
[account:field_last_name] 值是与用户的姓氏对应的替换模式。如需查看替换模式的完整列表,请选择值输入框下的替换模式。 - 将开发者 UID 设置为 [account:uid]。此值是将用户与应用相关联所必需的值。
- 将应用状态设置为待处理或已批准。如果用户仍需要管理员批准应用,才能使用该应用访问您的 API,请将其设置为待处理。
- 根据需要,为应用设置回调网址。只有在您将应用配置为需要回调网址时,此字段才会显示。如需详细了解如何配置回调网址,请参阅配置回调网址处理。
- 如果您定义了任何自定义应用属性(可选或必需属性),请进行设置。如需了解详情,请参阅自定义用于注册应用的表单字段。
- 指定应用中包含的 API 产品。
值文本区域中必须在每个 API 产品的单独行中列出该产品,且不得使用英文逗号或其他分隔符。可用 API 产品的列表显示在 Value 文本区域上方。 - 点击保存,返回“修改规则”页面。
- 点击保存更改。
- 如需日后修改规则,请在 Drupal 管理菜单中依次选择 Configuration > Workflow > Rules,然后从规则列表中选择相应规则。
现在,当新用户首次登录门户并选择菜单中的“我的应用”链接时,会看到一个名为 lastName 应用的应用,其中 lastName 是用户注册账号时使用的姓氏。
管理用户应用
作为门户管理员,您可以使用“开发者应用”报告直接从门户管理用户应用。管理员可以通过该报告查看用户应用的相关信息、修改应用或删除应用。例如,门户管理员可以修改应用以添加或移除 API 产品、更改回调网址或进行其他更改。
如需管理用户应用,请按以下步骤操作:
- 以具有管理员权限的用户身份登录门户。
- 在 Drupal 管理菜单中,依次选择报告 > 开发者应用。系统会显示可对用户应用进行排序的列表。
- 对于列表中的任何应用:
- 选择修改链接以修改应用属性。
- 选择删除链接以删除应用。
取消用户账号
门户管理员可以取消用户账号。管理员可以取消单个账号,也可以批量取消多个账号。
如要取消单个用户账号,请执行以下操作:
- 以具有管理员权限的用户身份登录门户。
- 在 Drupal 管理菜单中,选择用户。
- 在用户表格的操作列下,选择取消账号。
- 点击“取消用户账号时”下方的相应取消选项。选项包括:
- 停用账号并保留其内容:(默认)系统会保留用户账号及其相关内容。不过,该用户账号被禁止访问 API 资源。这是默认设置。管理员随后可以解除对用户账号的屏蔽。
- 停用账号并取消发布其内容:系统会保留用户账号。不过,系统会移除与该用户账号关联的内容。用户账号被禁止访问 API 资源。管理员随后可以解除对用户账号的屏蔽。
- 删除账号,但将其内容归匿名用户所有: 用户账号会被删除。系统会保留与用户账号关联的内容,但会将其关联到“匿名”用户账号(即未经过身份验证的账号)。用户账号无法重新启用。用户需要重新注册,并且用户的账号需要经过身份验证,然后才能访问 API 资源。
- 删除账号及其内容:系统会删除用户账号及其相关内容。用户账号无法重新启用。用户需要重新注册,并且用户的账号需要经过身份验证,然后才能访问 API 资源。
- 如果您希望系统向用户发送一封电子邮件,要求他们确认取消操作,请选择要求用户通过电子邮件确认才能取消账号。
如果您选择此选项,用户的账号必须具有正确的权限才能允许取消。依次选择用户 > 权限,并确保“已验证身份的用户”角色已设置“取消自己的用户账号”权限。 - 点击撤销账号。
如需取消多个用户账号,请执行以下操作:
- 以具有管理员权限的用户身份登录门户。
- 在 Drupal 管理菜单中,选择用户。
- 在操作下,从下拉菜单中选择撤销用户账号。
- 选中您要撤销账号的每位用户旁边的复选框。
- 选择执行按钮。
- 点击“取消用户账号时”下方的相应取消选项。选项包括:
- 停用账号并保留其内容。
- 停用账号并取消发布其内容。
- 删除账号,但将其内容归属“匿名用户”。
- 删除账号及其内容。
- 点击下一步。
- 点击确认。
设置账号取消时的默认操作
开发者门户的管理员可以设置在用户账号被取消时门户的默认操作。
如需设置账号取消时的默认操作,请执行以下操作:
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中,选择配置。
- 选择账号设置。
- 在“注册和取消”部分的“取消用户账号时”下,点击相应的取消选项。选项包括:
- 停用账号并保留其内容。
- 停用账号并取消发布其内容。
- 删除账号,但将其内容归属“匿名用户”。
- 删除账号及其内容。
- 点击保存配置。