Orchestrator API ガイド

デリバリー:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

最終更新日時 2024年10月31日

認証

API 認証により、許可された関係者のみが、利用可能なリソースを操作したり必要なアクションを実行したりできるようになります。UiPath では、さまざまなシナリオに対応する複数の認証方法を用意しています。

利用可能な認証方法について詳しくは、こちらをご覧ください。

ベアラートークンによるローカルユーザー認証 (ROPC 認証)

重要: ROPC による認証は、スタンドアロンから Automation Suite のデプロイに移行した Orchestrator インスタンスの後方互換性を確保するためにサポートされています。/api/account/authenticate/ エンドポイントを使用して認証するのはホスト管理者だけにしてください。ビジネスユーザーは外部アプリケーションを使用して認証する必要があります。

リソース所有者のパスワード資格情報の認証方法はテナントが対象範囲であり、外部アプリケーションはテナントレベルで作成できないため、この方法では外部アプリを認証できません。

アクセストークンを取得するには、次のペイロードを使用して {OrchestratorURL}/api/account/authenticate エンドポイントに POST 要求を送信します。
```
{
    "TenancyName": "{account_tenancy_name}",
    "UsernameOrEmailAddress": "{account_username}",
    "Password": "{account_password}"
}{
    "TenancyName": "{account_tenancy_name}",
    "UsernameOrEmailAddress": "{account_username}",
    "Password": "{account_password}"
}
```
上記の要求で、
- {account_tenancy_name} — Automation Suite アカウントのテナントの一意の識別子です。
- {account_username} は Automation Suite アカウントのユーザー名です。
- {account_password} は Automation Suite アカウントへのログインに使用するパスワードです。
Orchestrator インスタンスの TenancyName の値を確認するには、/odata/Users/UiPath.Server.Configuration.OData.GetCurrentUser エンドポイントに GET 要求を送信します。
応答本文ではベアラートークンが返され、これをアプリケーションで使用して以降の API 呼び出しを認可します。したがって、API 呼び出しの認可ヘッダーに Bearer xxxx を追加します。xxxx は {access_token} の値に置き換えます (例: Authorization: Bearer eyJhbG ... LnVxjA)。
```
{
    "result": "{access_token}",
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}{
    "result": "{access_token}",
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}
```
既定では、アクセストークンは 30 分間有効です。新しいトークンを生成するには、もう一度 api/account/authenticate エンドポイントの呼び出しを行います。
重要: 組織で Azure Active Directory モデルを使用している場合は、外部アプリケーションを Orchestrator に登録して OAuth フローを使用する必要があります。