test-cloud

latest

false

重要 :

新发布内容的本地化可能需要 1-2 周的时间才能完成。

Test Cloud API 指南

适用平台：

上次更新日期 2026年4月7日

外部客户端

列出所有外部客户端

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

API 端点

GET {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Test Cloud	`https://cloud.uipath.com/`
Test Cloud 公共部门版	`https://govcloud.uipath.us/`
Test Cloud 专用版	`https://{customURL}.dedicated.uipath.com/`

作用域

需要以下任一作用域：

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 {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Test Cloud	`https://cloud.uipath.com/`
Test Cloud 公共部门版	`https://govcloud.uipath.us/`
Test Cloud 专用版	`https://{customURL}.dedicated.uipath.com/`

作用域

需要以下任一作用域：

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 {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Test Cloud	`https://cloud.uipath.com/`
Test Cloud 公共部门版	`https://govcloud.uipath.us/`
Test Cloud 专用版	`https://{customURL}.dedicated.uipath.com/`

作用域

需要以下任一作用域：

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 {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Test Cloud	`https://cloud.uipath.com/`
Test Cloud 公共部门版	`https://govcloud.uipath.us/`
Test Cloud 专用版	`https://{customURL}.dedicated.uipath.com/`

作用域

需要以下任一作用域：

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 {accessURL}/{organizationName}/identity_/api/ExternalClient

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Test Cloud	`https://cloud.uipath.com/`
Test Cloud 公共部门版	`https://govcloud.uipath.us/`
Test Cloud 专用版	`https://{customURL}.dedicated.uipath.com/`

作用域

需要以下任一作用域：

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 {accessURL}/{organizationName}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Test Cloud	`https://cloud.uipath.com/`
Test Cloud 公共部门版	`https://govcloud.uipath.us/`
Test Cloud 专用版	`https://{customURL}.dedicated.uipath.com/`

作用域

需要以下任一作用域：

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 {accessURL}/{organizationName}/identity_/api/ExternalClient/GenerateSecret

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Test Cloud	`https://cloud.uipath.com/`
Test Cloud 公共部门版	`https://govcloud.uipath.us/`
Test Cloud 专用版	`https://{customURL}.dedicated.uipath.com/`

作用域

需要以下任一作用域：

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 {accessURL}/{organizationName}/identity_/api/{partitionGlobalId}/secrets/{secretsId}

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Test Cloud	`https://cloud.uipath.com/`
Test Cloud 公共部门版	`https://govcloud.uipath.us/`
Test Cloud 专用版	`https://{customURL}.dedicated.uipath.com/`

作用域

需要以下任一作用域：

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 无内容

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

此页面有帮助吗？

前一个下载事件

下一个外部客户端 — 联合凭据

Test Cloud API 指南

列出所有外部客户端​

API 端点​

作用域​

请求标头​

请求正文​

响应​

200 成功​

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

API 端点​

作用域​

请求标头​

请求正文​

响应​

200 成功​

更新外部客户端​

API 端点​

作用域​

请求标头​

请求正文​

响应​

200 成功​

删除外部客户端​

API 端点​

作用域​

请求标头​

请求正文​

响应​

204 无内容​

新建外部客户端​

API 端点​

作用域​

请求标头​

请求正文​

响应​

201 已创建​

生成新密码​

API 端点​

作用域​

请求标头​

请求正文​

响应​

200 成功​

生成新的外部客户端​

API 端点​

作用域​

请求标头​

请求正文​

响应​

200 成功​

删除客户端密码​

API 端点​

作用域​

请求标头​

请求正文​

响应​

204 无内容​

此页面有帮助吗？

列出所有外部客户端

API 端点

作用域

请求标头

请求正文

响应

200 成功

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

API 端点

作用域

请求标头

请求正文

响应

200 成功

更新外部客户端

API 端点

作用域

请求标头

请求正文

响应

200 成功

删除外部客户端

API 端点

作用域

请求标头

请求正文

响应

204 无内容

新建外部客户端

API 端点

作用域

请求标头

请求正文

响应

201 已创建

生成新密码

API 端点

作用域

请求标头

请求正文

响应

200 成功

生成新的外部客户端

API 端点

作用域

请求标头

请求正文

响应

200 成功

删除客户端密码

API 端点

作用域

请求标头

请求正文

响应

204 无内容