automation-cloud
latest
false
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。 新しいコンテンツの翻訳は、およそ 1 ～ 2 週間で公開されます。
UiPath logo, featuring letters U and I in white

UiPath Automation Cloud API ガイド

最終更新日時 2025年10月16日

外部クライアント

すべての外部クライアントのリストを取得する

組織の外部クライアントの完全なリストを取得します。

API エンドポイント

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

スコープ

次のスコープのいずれかが必要です。

  • PM.OAuthApp
  • PM.OAuthApp.Read

要求ヘッダー

--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

要求ヘッダー

--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

要求ヘッダー

--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

要求ヘッダー

--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

要求ヘッダー

--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 Created

外部クライアントが正常に作成されました。

{
  "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
  • PM.OAuthSecret.Write

要求ヘッダー

--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
  • PM.OAuthAppSecret.Write

要求ヘッダー

--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
  • PM.OAuthAppSecret.Write

要求ヘッダー

--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 アカデミー
RPA について学ぶ - オートメーション コース
UiPath フォーラム
UiPath コミュニティ フォーラム
Uipath Logo
信頼とセキュリティ
利用規約
プライバシー ポリシー
Cookie ポリシー
© 2005-2025 UiPath. All rights reserved.