创建 OAuth 客户端

必备
  • OAuth > 客户端 > 添加 权限

OAuth 客户端允许您向平台 API 发出请求或针对 Genesys Cloud 进行身份验证，或在 Genesys Cloud 和第三方系统之间同步实体。

此过程适用于希望其应用接收令牌以允许其向 Genesys Cloud P latform API 发出请求的应用程序提供商。 令牌表示用户对应用程序访问 Genesys Cloud 数据的权限。 当应用程序必须向 API 终端节点发出请求授权时，会使用它。 要查看 Genesys 云平台 API 的列表，请参阅 Genesys 云开发人员中心中的 API 资源 。

  1. 单击 管理员。
  2. 在 集成下，单击 OAuth。

  3. 单击 添加客户端。 此时将显示 “客户端详细信息

  4. 将 应用程序名称设置 为应用程序的描述性名称。当有人 授权此 OAuth 客户端时，会显示 此名称。
  5. （可选）在描述 框中键入应用程序的简短 说明。
  6. 接下来，设置使用此客户端创建的令牌到期之前的持续时间。 接受默认持续时间，或输入一个介于 300 到 172800 秒之间的值。 这会将令牌的生命周期设置为最多 2 天或更短。
    注意： 为您的组织启用 HIPAA 合规性后，Genesys Cloud 会强制执行 15 分钟的空闲超时，此空闲超时也适用于 OAuth 客户端发行的令牌。 有关更多信息，请参阅 HIPAA 合规性。

  7. 在 “ 授予类型” 下方进行选择。 授权类型设置应用程序获取访问令牌的方式。 Genesys Cloud 支持下面列出的 OAuth 2 授权授权类型。 单击授权类型的名称可在 Genesys Cloud 开发人员中心中显示有关 该类型的更多信息。

    • 客户端凭证授予： 专供非用户应用程序使用的单步身份验证过程（例如 Windows 服务或 cron 作业）。 客户端应用程序提供 OAuth 客户端凭据以换取访问令牌。 此授权类型不在用户的上下文中，因此无法访问特定于用户的 API（例如 GET /v2/users/me）。

      如果为适用于 Salesforce 的 Genesys Cloud 分配角色，请参阅适用于 Salesforce 的 Genesys Cloud 的 OAuth 客户端权限。

    • 代码授权补助金： 两步身份验证过程，用户使用 Genesys Cloud 进行身份验证，然后向客户端应用程序返回授权码。 客户端应用程序提供 OAuth 客户端凭据，并使用授权码获取访问令牌。 然后可以在进行身份验证的 API 调用时使用访问令牌。 这是最安全的选项，非常适合将在服务器端发出 API 请求的网站（例如 ASP.NET 或 PHP）以及一些桌面应用程序，其中瘦客户端将授权用户并将身份验证代码传递给后端服务器以交换身份验证令牌并发出 API 请求。

    • 令牌隐式授权（浏览器） 单步身份验证过程，用户使用 Genesys Cloud 进行身份验证，然后直接向客户端应用程序返回访问令牌。 此选项为访问令牌提供的安全性低于授权码授予的安全性，但对于客户端浏览器应用程序（即 JavaScript）和大多数桌面应用程序（例如 .NET WPF/WinForms 或 Java 桌面程序）来说，它是理想的选择。

    • SAML2 Bearer 一种身份验证过程，其中客户端应用程序可以使用安全断言标记语言 (SAML2) 断言来请求不记名令牌。 另请参阅： Genesys Cloud 单点登录和身份提供商解决方案。

      注意： 所有区域都可以使用单个代码授权或隐式授权类型。

  8. 提供授权类型所需的参数。

    • 角色： 如果选择了 客户端凭据，请单击 角色选 项卡。 这将打开可供选择的角色列表。 分配一组最少的角色来确定 OAuth 客户端集成可以执行的操作。

      注意： 要向 OAuth 客户端授予角色，您必须将这些角色分配给您的配置文件。

      您还必须将每个角色与一个 部门关联起来。 确定哪些部门应与客户凭证授予的角色相关联。 默认情况下，所有客户凭证授予角色的范围都限于内政部门。 使用适当的部门进行更新，以便使用这些授权的应用程序和系统可以访问相应的数据。 如果客户凭证授予是由第三方提供的，请与第三方联系以了解授权的使用情况，并适当地更新角色的部门。 没有其他授权类型受访问控制的影响。

    • 授权的重定向 URI（每行一个，最多 125 个）： 这些是授权码发布到的 URI，用于交换访问令牌，稍后用于对后续 API 调用进行身份验证。

    • 范围 除客户端凭证之外的所有授权类型都有范围设置。 单击范围框以显示应用程序可用的范围列表。作为最佳实践，请仅选择应用所需的最小范围。 有关作用域的信息，请参阅开发人员中心中的 OAuth Scope 。 

  9. 单击 “ 保存”。 Genesys Cloud 创建客户端 ID 和客户端密钥（令牌）。

您的 Genesys Cloud OAuth 客户端现在可以使用了。

必备
  • OAuth > 客户端 > 添加 权限

如果任何一种情况适用，请为 Genesys 云嵌入式框架创建一个 OAuth 客户端：

  • 您正在实施公共部署。
  • 您正在实施一个私有部署，该部署可以访问 framework.js 文件中的 GetAuthToken 方法。 有关更多信息，请参阅 User.getAuthToken （Genesys 云开发人员中心）。

OAuth 客户端会生成一个客户端 ID，开发人员可以将其用于 framework.js 文件 中的 客户端 ID。 有关更多信息，请参阅 C lientID （Genesys 云开发人员中心）。

  1. 单击 管理员。
  2. 在 集成下，单击 OAuth。
  3. 单击 添加客户端。 此时将显示 “客户端详细信息

    OAuth 客户端的 “客户端详细信息”

  4. 将 应用程序名称设置 为应用程序的描述性名称。

    应用程序名称是有人授权此 OAuth 客户端时显示的名称。 有关详细信息，请参阅 授权 OAuth 客户端。

  5. （可选）在描述 框中键入应用程序的简短 说明。
  6. 设置使用此客户端创建的令牌到期之前的持续时间。

    接受默认持续时间，或输入一个介于 300 到 172800 秒之间的值。 此持续时间将令牌的生命周期设置为最多两天或更短的时间。

    提示： Genesys 建议您将令牌持续时间设置为 18 小时（64800 秒）。 此持续时间通常会导致令牌在座席的正常工作日之外过期。

  7. 在 授权类型下，选择 隐式授权（浏览器）。

    有关更多信息，请参阅 授权 （Genesys 云开发人员中心）和 授权 — 隐式 （Genesys Cloud 开发人员中心）。

  8. 在 授权的重定向 URI 下，添加 https://apps.mypurecloud.com/crm/index.html，根据您的 Genesys Cloud 区域进行自定义。

    注释：
    • 根据您的部署情况使用 AWS 区域。
    • 如果你在 framework.js 文件中将 专用 LoginWindow 设置 为 true，也可以在 授权重定向 URI 下添加 https://apps.mypurecloud.com/crm/authWindow.html。 有关更多信息，请参阅 设置 下的 专用 LoginWindow （Genesys 云开发人员中心）。
    • Genesys 发布您的公共部署后，Genesys 将为您提供一个新的 URI 供您使用。
  9. 在 S cope 下，添加所有必需的作用域。 您还可以添加其他作用域。

    有关所需范围的列表，请参阅 Genesys Cloud 嵌入式客户端的 管理员要求。 有关作用域的信息，请参阅 OAuth Scope （Genesys Cloud 开发人员中心）。

  10. 单击 “ 保存”。

    Genesys Cloud 会创建客户端 ID 和客户端密钥。

  11. 向开发人员提供 客户端 ID。

    开发人员必须将客户端 ID 添加到 framework.js 文件 中的 ClientID 中。 有关更多信息，请参阅 C lientID （Genesys 云开发人员中心）。

有关集成的更多信息，请参阅 关于 Genesys Cloud 嵌入式框架。

必备
  • OAuth > 客户端 > 添加 权限
  • 分配给用户的 SCIM 集成角色

    如果未显示 SCIM 集成，请将默认角色还原到 Genesys Cloud 组织。 使用 API 资源管理器对 POST /api/v2/ 授权/角色/默认值进行 API 调用。 有关更多信息，请参阅 开发人员工具快速入门 （Genesys Cloud 开发人员中心）。 要访问 API 资源管理器，请访问 https://developer.genesys.cloud/developer-tools/#/api-explorer。

要使用 Genesys Cloud SCIM（身份管理），请创建 Genesys 云 OAuth 客户端。 OAuth 客户端生成一个客户端 ID 和客户端密钥，您将其添加到身份管理系统中。

  1. 单击 管理员。
  2. 在 集成下，单击 OAuth。
  3. 单击 添加客户端。 此时将显示 “客户端详细信息
  4. 将 应用程序名称设置 为应用程序的描述性名称。

    应用程序名称是有人授权此 OAuth 客户端时显示的名称。 有关详细信息，请参阅 授权 OAuth 客户端。

  5. （可选）在描述 框中键入应用程序的简短 说明。
  6. 设置 令牌持续时间。 

    令牌持续时间是指使用此客户端创建的令牌到期之前的持续时间。 接受默认持续时间 86,400，或输入一个介于 300 到 38,880,000 秒之间的值。 这将令牌的生命周期设置为最长 450 天。

    注意： 如果您使用 SCIM 集成角色或具有完全相同权限的自定义角色，则只能将最长时间设置为 38,880,000 秒。

  7. 在 授权类型下，选择 客户端凭证。
  8. 单击 角色 选项卡，然后分配 SCIM 集成 角色。 
    重要提示：
    • 要将此角色授予 OAuth 客户端，您必须将此角色分配给您的配置文件。
    • 请勿将其他角色分配给您的 OAuth 客户端或向 SCIM 集成角色分配其他权限。 如果您确实分配了其他角色或权限，则在步骤 6 中设置的 令牌持续时间 将恢复为默认值 86,400 秒。
    • 包括您将使用 SCIM 管理的所有部门。
  9. 单击 “ 保存”。

    Genesys Cloud 会创建客户端 ID 和客户端密钥。 在身份管理系统的配置中使用这些标识符。

有关 Genesys Cloud SCIM（身份管理）的信息，请参阅 关于 Genesys Cloud SCIM（身份管理） 和 Genesys Cloud SCIM（身份管理）概述 （Genesys 云开发人员中心）。