外部クライアント - フェデレーション資格情報

フェデレーション資格情報を使用すると、OAuth 外部アプリケーションは、外部 ID プロバイダーが発行する JSON Web Token (JWT) を使用して UiPath に対して認証できます。クライアント シークレットは必要ありません。各アプリケーションは、最大で 20 個のフェデレーション資格情報をサポートします。

登録済みの OAuth 外部アプリケーションのフェデレーション資格情報を表示、作成、取得、更新、削除するには、このページのエンドポイントを使用します。外部アプリケーション自体を管理するには、「外部の OAuth アプリケーションを管理する」をご覧ください。

すべてのエンドポイント パスの {accessURL} は、ご使用のクラウド プラットフォームのベース URL に置き換えてください。

Cloud Platform	アクセス URL
Test Cloud	https://cloud.uipath.com/
Test Cloud (公共部門向け)	https://govcloud.uipath.us/
Test Cloud (専有型)	https://{customURL}.dedicated.uipath.com/

---

フェデレーション資格情報のリストを取得

特定の OAuth 外部アプリケーションに対して登録されているすべてのフェデレーション資格情報を取得します。

API エンドポイント

GET {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials

パス パラメーター

パラメーター	説明
partitionGlobalId	組織のグローバル ID です。
clientId	OAuth 外部アプリケーションの ID です。

スコープ

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

• PM.OAuthApp
• PM.OAuthApp.Read

要求ヘッダー

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

注:

{access_token} を取得するには、組織管理者のトークンを使用するか、「認証方法」に記載されているいずれかの方法で認証を行います。

応答

200 OK

FederatedCredentialDto オブジェクトの配列を返します。資格情報が登録されていない場合は、空の配列を返します。

要求の例

curl --request GET \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials' \
  --header 'Authorization: Bearer {access_token}'

応答の例

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
    "name": "GitHub Actions",
    "description": "Used for GitHub Actions CI/CD pipeline",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "https://cloud.uipath.com/myorg",
    "subject": "repo:myorg/myrepo:ref:refs/heads/main",
    "createdAt": "2026-03-01T10:00:00Z",
    "updatedAt": "2026-03-01T10:00:00Z"
  }
]

---

フェデレーション資格情報を作成する

特定の OAuth 外部アプリケーションのフェデレーション ID 資格情報を作成します。

注:

各アプリケーションは、最大で 20 個のフェデレーション資格情報をサポートします。

API エンドポイント

POST {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials

パス パラメーター

パラメーター	説明
partitionGlobalId	組織のグローバル ID です。
clientId	OAuth 外部アプリケーションの ID です。

スコープ

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

• PM.OAuthApp
• PM.OAuthApp.Write

要求ヘッダー

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

要求本文

{
  "name": "azure-production-workload",
  "description": "Federated credential for production Azure workload",
  "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0",
  "audience": "api://uipath-production",
  "subject": "00000000-0000-0000-0000-000000000000"
}

フィールド	Required	説明
name	はい	資格情報のわかりやすい名前です。アプリケーション内で一意である必要があります。最長 128 文字です。
description	いいえ	資格情報の任意のコンテキストです。最大 512 文字です。
issuer	はい	外部 ID プロバイダーの HTTPS URI です。作成時にアクセス可能である必要があります。
audience	はい	JWT の aud クレームに含める必要がある単一の文字列です。
subject	はい	JWT の sub クレームと完全に一致する必要がある値です。

応答

201 Created

作成された FederatedCredentialDto オブジェクトを返します。

400 Bad Request

要求は無効です。考えられる原因: name がクライアント内で一意でないか、issuer が有効な HTTPS URI ではないか、発行者の JWKS エンドポイントにアクセスできないか、アプリケーションあたりの資格情報の最大数である 20 に達しています。

404 見つかりません

指定した clientId が存在しないか、呼び出し元の組織に属していません。

要求の例

curl --request POST \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "GitHub Actions",
    "description": "Used for GitHub Actions CI/CD pipeline",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "https://cloud.uipath.com/myorg",
    "subject": "repo:myorg/myrepo:ref:refs/heads/main"
  }'

応答の例

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
  "name": "GitHub Actions",
  "description": "Used for GitHub Actions CI/CD pipeline",
  "issuer": "https://token.actions.githubusercontent.com",
  "audience": "https://cloud.uipath.com/myorg",
  "subject": "repo:myorg/myrepo:ref:refs/heads/main",
  "createdAt": "2026-03-01T10:00:00Z",
  "updatedAt": "2026-03-01T10:00:00Z"
}

---

フェデレーション資格情報を取得する

特定のフェデレーション資格情報をその ID で取得します。

API エンドポイント

GET {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}

パス パラメーター

パラメーター	説明
partitionGlobalId	組織のグローバル ID です。
clientId	OAuth 外部アプリケーションの ID です。
credentialId	フェデレーション資格情報の ID。

スコープ

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

• PM.OAuthApp
• PM.OAuthApp.Read

要求ヘッダー

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

応答

200 OK

要求された資格情報の FederatedCredentialDto オブジェクトを返します。

404 見つかりません

指定した資格情報またはアプリケーションが呼び出し元の組織に存在しません。

要求の例

curl --request GET \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}' \
  --header 'Authorization: Bearer {access_token}'

応答の例

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
  "name": "GitHub Actions",
  "description": "Used for GitHub Actions CI/CD pipeline",
  "issuer": "https://token.actions.githubusercontent.com",
  "audience": "https://cloud.uipath.com/myorg",
  "subject": "repo:myorg/myrepo:ref:refs/heads/main",
  "createdAt": "2026-03-01T10:00:00Z",
  "updatedAt": "2026-03-15T08:30:00Z"
}

---

フェデレーション資格情報を更新する

既存のフェデレーション資格情報を更新します。すべての必須フィールドが要求本文に含まれている必要があります。

API エンドポイント

PUT {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}

パス パラメーター

パラメーター	説明
partitionGlobalId	組織のグローバル ID です。
clientId	OAuth 外部アプリケーションの ID です。
credentialId	更新するフェデレーション資格情報の ID です。

スコープ

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

• PM.OAuthApp
• PM.OAuthApp.Write

要求ヘッダー

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

要求本文

{
  "name": "azure-production-workload-updated",
  "description": "Updated description",
  "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0",
  "audience": "api://uipath-production",
  "subject": "00000000-0000-0000-0000-000000000000"
}

フィールド	Required	説明
name	はい	資格情報のわかりやすい名前です。アプリケーション内で一意である必要があります。最長 128 文字です。
description	いいえ	資格情報の任意のコンテキストです。最大 512 文字です。
issuer	はい	外部 ID プロバイダーの HTTPS URI です。作成時にアクセス可能である必要があります。
audience	はい	JWT の aud クレームに含める必要がある単一の文字列です。
subject	はい	JWT の sub クレームと完全に一致する必要がある値です。

応答

200 OK

更新された FederatedCredentialDto オブジェクトを返します。

400 Bad Request

検証に失敗しました。考えられる原因: name が重複しているか、発行者の URI が無効であるか、または JWKS エンドポイントにアクセスできません。

要求の例

curl --request PUT \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "GitHub Actions — Production",
    "description": "Production branch deployments only",
    "issuer": "https://token.actions.githubusercontent.com",
    "audience": "https://cloud.uipath.com/myorg",
    "subject": "repo:myorg/myrepo:ref:refs/heads/main"
  }'

応答の例

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "1539a53a-e34f-4803-adef-b9cd82f18858",
  "name": "GitHub Actions — Production",
  "description": "Production branch deployments only",
  "issuer": "https://token.actions.githubusercontent.com",
  "audience": "https://cloud.uipath.com/myorg",
  "subject": "repo:myorg/myrepo:ref:refs/heads/main",
  "createdAt": "2026-03-01T10:00:00Z",
  "updatedAt": "2026-03-20T14:00:00Z"
}

---

フェデレーション資格情報を削除する

フェデレーション資格情報を削除します。この操作は永続的なもので、この資格情報を使用したトークンの取得は直ちに無効になります。

警告:

削除は永続的です。削除されると、その資格情報を使用して新しいアクセス トークンを取得することはできなくなります。削除前に発行済みだったアクセス トークンは、有効期限が切れるまで有効です。

API エンドポイント

DELETE {accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}

パス パラメーター

パラメーター	説明
partitionGlobalId	組織のグローバル ID です。
clientId	OAuth 外部アプリケーションの ID です。
credentialId	削除するフェデレーション資格情報の ID です。

スコープ

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

• PM.OAuthApp
• PM.OAuthApp.Write

要求ヘッダー

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

応答

204 No Content

フェデレーション資格情報は正常に削除されました。応答本文は空です。

404 見つかりません

指定した資格情報またはアプリケーションが呼び出し元の組織に存在しません。

要求の例

curl --request DELETE \
  '{accessURL}/identity_/api/ExternalClient/{partitionGlobalId}/{clientId}/FederatedCredentials/{credentialId}' \
  --header 'Authorization: Bearer {access_token}'

---

フェデレーション資格情報を使用してトークンを取得する

外部 ID プロバイダーの JWT を UiPath アクセス トークンと交換します。

API エンドポイント

POST {accessURL}/identity_/connect/token

要求ヘッダー

--header 'Content-Type: application/x-www-form-urlencoded'

要求本文

grant_type=client_credentials
&client_id={client_id}
&client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer
&client_assertion={jwt_token}
&scope={requested_scopes}

パラメーター	説明
grant_type	client_credentialsする必要があります。
client_id	登録済みの OAuth 外部アプリケーションのクライアント ID。
client_assertion_type	urn:ietf:params:oauth:client-assertion-type:jwt-bearerする必要があります。
client_assertion	外部 ID プロバイダーによって発行された JWT です。
scope	アクセス トークンに対して要求する OAuth スコープです。

応答

200 OK

アクセス トークン オブジェクトを返します。access_token の値は、後続の API 呼び出しの Authorization: Bearer ヘッダーで使用します。

400 Bad Request

トークンの取得に失敗しました。考えられる原因: JWT 署名が無効であるか、発行者またはオーディエンスが一致していないか、サブジェクトが一致していないか、JWT が期限切れであるか、または JWT が 8 KB を超えています。

---

スキーマ

FederatedCredentialDto

GET、POST、PUT の操作で返されるオブジェクトです。

プロパティ	入力	null の許容	説明
id	string (uuid)	いいえ	フェデレーション資格情報の一意の識別子です。
clientId	string	はい	この資格情報が属する OAuth 外部アプリケーションのアプリケーション ID です。
name	string	はい	フェデレーション資格情報の表示名です。
description	string	はい	フェデレーション資格情報の説明。
issuer	string	はい	外部 ID プロバイダーの URL です。
audience	string	はい	JWT で期待される aud クレームの値です。
subject	string	はい	JWT で期待される sub クレームの値です。
createdAt	string (date-time)	いいえ	資格情報が作成された際の UTC タイムスタンプ。
updatedAt	string (date-time)	いいえ	資格情報が最後に更新されたときの UTC タイムスタンプ。