Orchestrator
v2023.4
バナーの背景画像
Orchestrator API ガイド
最終更新日 2023年11月10日

認証

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

重要: ROPC による認証は、スタンドアロンから Automation Suite のデプロイに移行した Orchestrator インスタンスの後方互換性を確保するためにサポートされています。/api/account/authenticate/ エンドポイントを使用して認証するのはホスト管理者だけにしてください。ビジネス ユーザー外部アプリケーションを使用して認証する必要があります。
リソース所有者のパスワード資格情報の認証方法はテナントが対象範囲であり、外部アプリケーションはテナント レベルで作成できないため、この方法では外部アプリを認証できません。
  1. アクセス トークンを取得するには、次のペイロードを使用して {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 アカウントへのログインに使用するパスワードです。
  2. 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 フローを使用する必要があります。

Swagger

If you are using Swagger to try our API, just log in to your Orchestrator instance in a separate tab.

Orchestrator API Swagger 定義にアクセスするには、Orchestrator の URL にサフィックス /swagger/ui/index#/ を追加します。例: https://myOrchestrator.com/swagger/ui/index#/
注: Swagger 認証は、Orchestrator インスタンスで設定したパラメーターに従って期限切れになります。既定では、この値は 30 分に設定されています。変更するには、Web.config ファイルの Auth.Cookie.Expire パラメーターの値を変更します。

Was this page helpful?

サポートを受ける
RPA について学ぶ - オートメーション コース
UiPath コミュニティ フォーラム
UiPath ロゴ (白)
信頼とセキュリティ
© 2005-2024 UiPath. All rights reserved.