automation-cloud
latest
false
  • 入门指南
    • 关于本指南
    • 可用资源：
    • API 端点 URL 结构
    • 枚举列表
  • 身份验证
    • 身份验证方法
    • 外部应用程序 (OAuth)
    • 其他 API 访问方法
  • 作用域和权限
  • 平台管理 API
重要 :
请注意，此内容已使用机器翻译进行了部分本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。
UiPath logo, featuring letters U and I in white

Automation Cloud API 指南

上次更新日期 2025年10月9日

外部客户端

列出所有外部客户端

获取组织的外部客户端完整列表。

API 端点

GET https://cloud.uipath.com/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}

作用域

需要以下任一作用域：

  • PM.OAuthApp
  • PM.OAuthApp.Read（用于 GET 请求）

请求标头

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
注意：如要获取 {access_token}，请确保通过此处描述的其中一种方法进行身份验证。

请求正文

请求正文包含要从中检索外部客户端的组织 ID。 

{
  "partitionGlobalId": "<organizationId>"
}{
  "partitionGlobalId": "<organizationId>"
}

响应

200 成功

已成功检索到给定组织的外部客户端列表。 

[
  {
    "name": "string",
    "id": "string",
    "secret": "string",
    "isConfidential": true,
    "redirectUri": "string",
    "resources": [
      {
        "name": "string",
        "displayName": "string",
        "description": "string",
        "scopes": [
          {
            "name": "string",
            "displayName": "string",
            "description": "string",
            "type": "user"
          }
        ]
      }
    ],
    "secrets": [
      {
        "id": 0,
        "description": "string",
        "secret": "string",
        "creationTime": "2025-07-18T12:52:37.566Z",
        "expiryTime": "2025-07-18T12:52:37.566Z"
      }
    ]
  }
][
  {
    "name": "string",
    "id": "string",
    "secret": "string",
    "isConfidential": true,
    "redirectUri": "string",
    "resources": [
      {
        "name": "string",
        "displayName": "string",
        "description": "string",
        "scopes": [
          {
            "name": "string",
            "displayName": "string",
            "description": "string",
            "type": "user"
          }
        ]
      }
    ],
    "secrets": [
      {
        "id": 0,
        "description": "string",
        "secret": "string",
        "creationTime": "2025-07-18T12:52:37.566Z",
        "expiryTime": "2025-07-18T12:52:37.566Z"
      }
    ]
  }
]

获取特定外部客户端的详细信息

从组织中获取特定的外部客户端，并获取最早密码的密码 ID。

API 端点

GET https://cloud.uipath.com/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}

作用域

需要以下任一作用域：

  • PM.OAuthApp
  • PM.OAuthApp.Read（用于 GET 请求）

请求标头

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
注意：如要获取 {access_token}，请确保通过此处描述的其中一种方法进行身份验证。

请求正文

请求正文包含要从中获取外部客户端的组织 ID 以及相应的客户端 ID。 

{
  "partitionGlobalId": "<organizationId>"
  "clientId": "<clientId>"
}{
  "partitionGlobalId": "<organizationId>"
  "clientId": "<clientId>"
}

响应

200 成功

已成功检索到外部客户端。

{
  "name": "string",
  "id": "string",
  "secret": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "resources": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "scopes": [
        {
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "user"
        }
      ]
    }
  ],
  "secrets": [
    {
      "id": 0,
      "description": "string",
      "secret": "string",
      "creationTime": "2025-07-18T12:57:01.155Z",
      "expiryTime": "2025-07-18T12:57:01.155Z"
    }
  ]
}{
  "name": "string",
  "id": "string",
  "secret": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "resources": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "scopes": [
        {
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "user"
        }
      ]
    }
  ],
  "secrets": [
    {
      "id": 0,
      "description": "string",
      "secret": "string",
      "creationTime": "2025-07-18T12:57:01.155Z",
      "expiryTime": "2025-07-18T12:57:01.155Z"
    }
  ]
}

更新外部客户端

更新外部 OAuth 应用程序的名称、重定向 URL、作用域或证书。

API 端点

PUT https://cloud.uipath.com/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

作用域

需要以下任一作用域：

  • PM.OAuthApp
  • PM.OAuthApp.Write（用于 PUT 请求）

请求标头

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
注意：如要获取 {access_token}，请确保通过此处描述的其中一种方法进行身份验证。

请求正文

请求正文包含特定外部客户端所在的组织 ID 以及相应的客户端 ID。
{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}

响应

200 成功

已成功更新指定的外部客户端。

Example Value
Schema
{
  "name": "string",
  "redirectUri": "string",
  "scopes": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "user"
    }
  ],
  "clientCertificates": [
    {}
  ]
}Example Value
Schema
{
  "name": "string",
  "redirectUri": "string",
  "scopes": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "user"
    }
  ],
  "clientCertificates": [
    {}
  ]
}

删除外部客户端

删除特定外部客户端。

API 端点

DELETE https://cloud.uipath.com/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

作用域

需要以下任一作用域：

  • PM.OAuthApp
  • PM.OAuthApp.Write（用于 PUT 请求）

请求标头

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
注意：如要获取 {access_token}，请确保通过此处描述的其中一种方法进行身份验证。

请求正文

请求正文包含要从中删除外部客户端的组织 ID，以及相应的客户端 ID。 

{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}

响应

204 无内容

已成功删除外部客户端。未返回任何值。

新建外部客户端

创建一个新的外部客户端。

API 端点

POST https://cloud.uipath.com/{organizationName}/identity_/api/ExternalClient

作用域

需要以下任一作用域：

  • PM.OAuthApp
  • PM.OAuthApp.Write（用于 PUT 请求）

请求标头

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
注意：如要获取 {access_token}，请确保通过此处描述的其中一种方法进行身份验证。

请求正文

请求正文包含组织 ID、外部客户端名称、机密状态、重定向 URI、所需的作用域和客户端证书。 

{
  "partitionGlobalId": "orgId",
  "name": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "scopes": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "user"
    }
  ],
  "clientCertificates": [
    {}
  ]
}{
  "partitionGlobalId": "orgId",
  "name": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "scopes": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "type": "user"
    }
  ],
  "clientCertificates": [
    {}
  ]
}

响应

201 已创建

已成功创建外部客户端。

{
  "name": "string",
  "id": "string",
  "secret": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "resources": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "scopes": [
        {
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "user"
        }
      ]
    }
  ],
  "secrets": [
    {
      "id": 0,
      "description": "string",
      "secret": "string",
      "creationTime": "2025-07-18T13:53:12.823Z",
      "expiryTime": "2025-07-18T13:53:12.823Z"
    }
  ]
}{
  "name": "string",
  "id": "string",
  "secret": "string",
  "isConfidential": true,
  "redirectUri": "string",
  "resources": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "scopes": [
        {
          "name": "string",
          "displayName": "string",
          "description": "string",
          "type": "user"
        }
      ]
    }
  ],
  "secrets": [
    {
      "id": 0,
      "description": "string",
      "secret": "string",
      "creationTime": "2025-07-18T13:53:12.823Z",
      "expiryTime": "2025-07-18T13:53:12.823Z"
    }
  ]
}

生成新密码

为给定的外部客户端生成新的客户端密码。

API 端点

GET https://cloud.uipath.com/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

作用域

需要以下任一作用域：

  • PM.OAuthApp
  • PM.OAuthApp.Write（用于 PUT 请求）
  • PM.OAuthSecret.Write（用于 PUT 请求）

请求标头

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
注意：如要获取 {access_token}，请确保通过此处描述的其中一种方法进行身份验证。

请求正文

请求正文包含外部客户端所在的组织 ID 以及相应的客户端 ID。 

{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}{
  "partitionGlobalId": "<organizationId>",
  "clientId": "<clientId>"
}

响应

200 成功
已成功为给定的外部客户端创建客户端密码。
"string""string"

生成新的外部客户端

生成新的外部客户端。

API 端点

POST https://cloud.uipath.com/{organizationName}/identity_/api/ExternalClient/GenerateSecret

作用域

需要以下任一作用域：

  • PM.OAuthApp
  • PM.OAuthApp.Write（用于 PUT 请求）
  • PM.OAuthAppSecret.Write（用于 PUT 请求）

请求标头

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
注意：如要获取 {access_token}，请确保通过此处描述的其中一种方法进行身份验证。

请求正文

请求正文包含要为其生成密码的客户端 ID、相应的描述和组织 ID。 

{
  "clientId": "string",
  "description": "string",
  "partitionGlobalId": "orgId",
  "expiryTime": "2025-07-18T13:24:15.806Z"
}{
  "clientId": "string",
  "description": "string",
  "partitionGlobalId": "orgId",
  "expiryTime": "2025-07-18T13:24:15.806Z"
}

响应

200 成功
已成功为给定的外部客户端生成新的客户端密码。
{
  "id": 0,
  "description": "string",
  "secret": "string",
  "creationTime": "2025-07-18T13:56:16.889Z",
  "expiryTime": "2025-07-18T13:56:16.889Z"{
  "id": 0,
  "description": "string",
  "secret": "string",
  "creationTime": "2025-07-18T13:56:16.889Z",
  "expiryTime": "2025-07-18T13:56:16.889Z"

删除客户端密码

删除客户端密码。

API 端点

DELETE https://cloud.uipath.com/{organizationName}/identity_/api/{partitionGlobalId}/secrets/{secretsId}

作用域

需要以下任一作用域：

  • PM.OAuthApp
  • PM.OAuthApp.Write（用于 PUT 请求）
  • PM.OAuthAppSecret.Write（用于 PUT 请求）

请求标头

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
注意：如要获取 {access_token}，请确保通过此处描述的其中一种方法进行身份验证。

请求正文

请求正文包含组织 ID 和要删除的客户端密码的 ID。 

{
  "partitionGlobalId": "<organizationId>",
  "secretId": "<secretId>"
}{
  "partitionGlobalId": "<organizationId>",
  "secretId": "<secretId>"
}

响应

204 无内容

已成功删除客户端密码。未返回任何值。

此页面有帮助吗？

支持与服务
获取您需要的帮助
UiPath Academy
了解 RPA - 自动化课程
UiPath 论坛
UiPath Community 论坛
Uipath Logo
信任与安全
使用条款
隐私策略
Cookie 政策
© 2005-2025 UiPath。保留所有权利。