Icertis 身份验证

此连接器支持两种身份验证类型：

• OAuth 2.0 授权代码（默认）

• API 密钥

OAuth 2.0 授权代码

OAuth 2.0 授权代码是 Icertis 连接器的默认身份验证类型。 该流程基于在 Microsoft Azure 中设置 OAuth 2.0 应用程序。

先决条件

要使用 OAuth 2.0 授权代码身份验证，您需要：

• Icertis 合同智能 (ICI) 平台的有效许可证或订阅。
• 有效的 Microsoft Azure 许可证或订阅。

授权流程

OAuth 2.0 授权代码身份验证方法使用以下授权流程：

1. 客户端应用程序从 Azure 授权服务器请求 ICI API 的 JWT 访问令牌。

2. Azure 令牌颁发端点验证凭据，并颁发 ICI API 的 JWT 访问令牌。

3. 通过 HTTPS，客户端应用程序使用返回的 JWT 访问令牌在 ICI API 请求的“授权”标头中添加指定为Bearer的 JWT 字符串。

4. ICI 的令牌验证处理程序使用 Azure 授权服务器验证访问令牌。

5. 如果令牌验证成功，ICI 会根据 ICI 存储库中针对用户映射的特定声明类型值设置用户上下文，并相应地返回所需资源。 此用户可以是服务或应用程序用户。

在 Microsoft Azure 中配置应用程序

按照以下步骤在 Azure 中配置 ICI 应用程序。

1. 登录到 Microsoft Azure 门户，网址为https://portal.azure.com/ 。 从主页中选择“应用程序注册”。
2. 在“应用程序注册” 页面中，选择“新建注册” 。
3. 在“注册应用程序”窗口中，提供新应用程序的以下详细信息：
   1. “名称” ：例如“ICM API”。
   2. 支持的帐户类型: 选择“仅此组织目录中的帐户（单租户）” 。
   3. 提供以下网页重定向 URI : https ://cloud.uipath.com/provisioning_/callback
   4. 选择“注册” 。 现在，新应用程序可在“应用程序注册”-“拥有的应用程序”选项卡中使用。
      
      

      

      
      
4. 从“应用程序注册”页面中选择您的应用程序。 “管理” 部分包括“身份验证”、“证书和密码”、“ API 权限” 等选项卡。 您可以使用这些部分进一步配置应用程序。
5. 在“身份验证” 选项卡中，您可以添加新的重定向 URI 或编辑现有重定向 URI。 在“隐式授权”下，选择“访问令牌” 。 这将启用隐式授权流程，并选择要由授权令牌颁发的令牌类型。
6. 接下来，在 “证书和密码” 下，选择“新建客户端密码” 。 在新窗口中，添加客户端密码说明（例如：“将用于访问令牌的 ICM API 密码”），并选择到期日期（例如一年）。 选择“添加”以创建新密码。

   复制客户端密码。 不要公开共享此密码，并将其存储在安全的位置。 您稍后将无法再次检索该密码。

7. 在“ 公开 API ”下，选择“ 应用程序 ID URI ” 旁边的“ 设置” 按钮。系统将显示一个表单，已生成默认值。 单击“保存” 进行保存。 应用程序 ID URI 使用以下格式： api://{Client ID} 。
   
   

   

   
   
8. 您的 Azure 应用程序现已使用默认作用域和授权类型设置完毕。 如果要添加自定义作用域，请在 “公开 API ” 下选择添加作用域。 配置新作用域，然后选择 “添加作用域”。
   
   

   

   
   

将应用程序详细信息发送到 Icertis

创建应用程序后，请联系您的 Icertis 管理员，并向他们提供您的开发和生产环境的以下详细信息：

必需的应用程序详细信息	详细信息	注释
应用程序 (客户端) ID	开发：[客户需要提供] Production: [客户将提供]	为访问 ICI API 而创建的应用程序的应用程序 ID
目录 (租户) ID	开发：[客户需要提供] Production: [客户将提供]	为访问 ICI API 而创建的应用程序的租户 ID
对象 ID	开发：[客户需要提供] Production: [客户将提供]	为访问 ICI API 而创建的应用程序的对象 ID
OpenID Connect 元数据文档	开发：[客户需要提供] Production: [客户将提供]	为访问 ICI API 而创建的应用程序的元数据文档 URL

ICI 配置

在 ICI 平台中，您需要达到最低配置设置才能开始使用。

在 Icertis 开发者团队的帮助下，在 ICI 应用程序的tenant.json文件中添加或更新以下密钥：

密钥	值	JSON 值
Core.API.OAuth.STSDiscoveryEndpoint	https://login.microsoftonline.com/{Directory (tenant) ID}/v2.0/.well-known/openid-configuration	{ "Id": "1033c3c0-6bf2-4a93-b813-c3ba42a199b3", "IsEncrypted": false, "OverrideType": "Overridable", "ValueType": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", "Value": "https://login.microsoftonline.com/{Directory (tenant) ID}/v2.0/.well-known/openid-configuration", "Description": "STS Discovery Endpoint URL", "DefaultValue": null, "IsReadOnly": false, "ErrorMessageDescription": null, "Name": "Core.API.OAuth.STSDiscoveryEndpoint" }
Core.API.OAuth.ValidAudiences	api://{Client ID}	{ "Id": "94c37b1b-2fb1-4f4e-a3de-6796279031e6", "IsEncrypted": false, "OverrideType": "Overridable", "ValueType": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", "Value": " api://{Client ID}", "Description": "Comma separated list of valid audiences", "DefaultValue": null, "IsReadOnly": false, "ErrorMessageDescription": null, "Name": "Core.API.OAuth.ValidAudiences" }
Core.API.OAuth.ValidIssuer	https://sts.windows.net/{Directory (tenant) ID}/	{ "Id": "d469b34c-f89f-42bb-934a-7ee4ef298130", "IsEncrypted": false, "OverrideType": "Overridable", "ValueType": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", "Value": "https://sts.windows.net/{Directory (tenant) ID}/", "Description": "OAuth Token issuer", "DefaultValue": null, "IsReadOnly": false, "ErrorMessageDescription": null, "Name": "Core.API.OAuth.ValidIssuer" }
Core.API.OAuth.ExternalUpnClaimUri	http://schemas.microsoft.com/identity/claims/objectidentifier	{ "Id": "1e783a54-b564-4748-a088-c04e8e05ab46", "IsEncrypted": false, "OverrideType": "Overridable", "ValueType": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089”, "Value":"http://schemas.microsoft.com/identity/claims/objectidentifier", "Description": "URL of the Claim to be used to uniquely identify user in ICI", "DefaultValue": null, "IsReadOnly": false, "ErrorMessageDescription": null, "Name": "Core.API.OAuth.ExternalUpnClaimUri" }

其中：

• Core.API.OAuth.STSDiscoveryEndpoint是在“应用注册” > “概述” > “端点” 中找到的 OpenID Connect 元数据文档值。
  
  

  

  
  
• Core.API.OAuth.ValidAudiences是在“应用注册” >“概述” 中找到的应用程序 ID URI。
• Core.API.OAuth.ValidIssuer是从iss URL和目录 (租户) ID 的组合中获得的标准声明值。 iss URL为https://sts.windows.net ，目录（租户）ID 位于“应用注册” >“概述” 中。
  
  

  

  
  
• Core.API.OAuth.ExternalUpnClaimUri是标准声明 URL。 ICI 使用带有以下 URL 的oid声明类型： http://schemas.microsoft.com/identity/claims/objectidentifier 。

在 ICI 级别准备就绪安装程序后，您可以使用从 Azure 收到的访问令牌测试 ICI API。 请注意，ICI 仅授权在 ICI 中配置的用户的访问令牌。

API 密钥

API 密钥身份验证方法使用 ICM 验证令牌创建连接。 使用此身份验证方法可以快速验证 API 是否已正确托管。

ICM 验证令牌是针对已登录的 Icertis 合同智能 (ICI) 平台用户生成的。 请注意，您可以为用户显式设置令牌过期日期。

1. 作为 ICI 用户，请导航到以下 URL 来检索 API 密钥： https://{{customerinstance}}.icertis.com/userinformation/GetUserApiToken 。
2. 使用浏览器的开发者工具检查页面并检索 UserApiToken。

添加 Icertis 连接

1. 从Automation Cloud ^TM中选择“Integration Service”。

2. 从“连接器”列表中，选择“Icertis”。 您还可以使用搜索栏来缩小连接器的范围。
3. 选择“连接到 Icertis”按钮。 您可以在两种身份验证类型之间进行选择：OAuth 2.0 授权代码或 API 密钥。
4. 输入首选身份验证所需的凭据：
   1. OAuth 2.0 授权代码（默认）：客户端 ID、客户端密码、租户 ID、作用域。
   2. API 密钥：API 密钥。
5. 选择“连接”。