利用可能なリソース

UiPath® では以下の API が公開されています。

• Orchestrator API
• Test Manager API
• プラットフォーム管理 API アクセス
  • 監査 - 組織内の監査ログを取得およびダウンロードします。
  • ライセンス - ライセンスを取得して割り当てます。
  • Identity - アカウントの作成、更新、削除、および組織設定の管理を行います。
• Document Understanding の API
• AI Center API
• Marketplace API
• アカデミー API
• Studio Web API
• コンテキスト グラウンディングの API アクセス
• PIMS (英語)
• Process Mining API アクセス
• トレース API アクセス
• Data Fabric API
• IXP.ExternalService

このガイドは、組織のプラットフォーム (プラットフォームの管理) のコンテキストにおける、リソースへのアクセスに特化しています。製品ベースの API については、専用の製品ドキュメントをご覧ください。

注:

プラットフォーム管理 API の機能強化を行っています。これにより、エンドポイントに重大な変更が生じる可能性があります。そのため、参照ドキュメントでは、現在の API は [プレビュー ] としてマークされています。

監査

• GET /audit_/api/auditlogs—組織の監査ログを取得します。
• GET /audit_/api/auditlogs/download — 組織の監査ログをダウンロードします。

グループ

• GET identity_/api/Group/{partitionGlobalId} - 指定したパーティション ID (組織またはテナント) からすべてのローカル グループと組み込みグループを取得します。
• GET /identity_/api/Group/{partitionGlobalId}/{groupId} - 指定したパーティション ID 内の指定したローカル グループまたは組み込みグループを取得します。
• POST /identity_/api/Group — 新しいローカル グループを作成します。
• PUT /identity_/api/Group/{groupId} - ローカル グループの情報を更新します。
• DELETE /identity_/api/Group/{partitionGlobalId} — 指定したパーティション ID (組織またはテナント) からすべてのローカル グループを削除します。
• DELETE /identity_/api/Group/{partitionGlobalId}/{groupId} — 指定したローカル グループを削除します。

ロボット アカウント

• GET /identity_/api/RobotAccount/{partitionGlobalId} — 指定したパーティション ID (組織またはテナント) 内のすべてのロボット アカウントを取得します。
• GET /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId} — 指定したパーティション ID 内の指定したロボット アカウントを取得します。
• POST /identity_/api/RobotAccount — 新しいロボット アカウントを作成します。
• PUT /identity_/api/RobotAccount/{robotAccountId} - 指定したロボット アカウントの情報を更新します。
• DELETE /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId} — 指定したロボット アカウントを削除します。
• DELETE /identity_/api/RobotAccount/{partitionGlobalId} - 指定したパーティション ID 内のすべてのロボット アカウントを削除します。

設定

• GET /identity_/api/Setting - 特定のテナントのキーのリストに基づいてアプリケーション設定を取得します。
• PUT /identity_/api/Setting - 特定のテナントで設定を更新するか、新しい設定を作成します。

SAML 証明書

• PUT https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/primary – プライマリ SAML 証明書をアップロードまたは更新します。
• PUT https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/secondary – セカンダリ SAML 証明書をアップロードまたは更新します。
• POST https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/switch – セカンダリ証明書をプライマリ証明書に切り替えます。
• GET https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/certificates – 組織の証明書のペアを取得します。
• DELETE https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/{certificateId} – ID に基づいて証明書を削除します。

ユーザー (User)

• GET /identity_/api/User/{userId} — 指定したユーザーの情報を取得します。
• POST /identity_/api/User/{userId}/changepassword — 指定したユーザーのパスワードを更新します。
• PUT /identity_/api/User/{userId} - 指定したユーザーの情報を更新します。
• DELETE /identity_/api/User - すべてのユーザーを削除します。
• DELETE /identity_/api/User/{userId} - 指定したユーザーを削除します。

ライセンスの割り当て

• GET /lease_/api/account​/{accountId}​/user-license​/group​/{groupId}—グループを作成または編集するために、利用可能なすべてのユーザー ライセンスのリストを取得します。
• PUT /lease_/api/account/{accountId}/user-license/group/{groupId} - グループ ルールを割り当てるか、更新します。