認証

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

利用可能な認証方法について詳しくは、Automation Suite のガイドをご覧ください。

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

重要:

We support authentication through ROPC for backwards compatibility for Orchestrator instances that have been migrated from standalone to Automation Suite deployments.Only Host administrators should authenticate using the /api/account/authenticate/ endpoint.Business users should authenticate using External Applications.

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

1. アクセス トークンを取得するには、次のペイロードを使用して {OrchestratorURL}/api/account/authenticate エンドポイントに POST 要求を送信します。

   {
       "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
   }
   

   既定では、アクセス トークンは 30 分間有効です。新しいトークンを生成するには、もう一度 api/account/authenticate エンドポイントの呼び出しを行います。

   重要:

   If your organization uses the Azure Active Directory model, you must register external applications in Orchestrator and use the OAuth flow.

Swagger にアクセスする

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

The Orchestrator API Swagger definition can be accessed by adding the /swagger/ui/index#/ suffix to your Orchestrator URL. For example, https://{yourDomain} /swagger/ui/index#/.

ドメイン ユーザーの認証

重要:

API access with Windows Auto-logon (NTLM authentication) has been removed, as indicated in the deprecation timeline.

代わりに OAuth フローを使用することをお勧めします。このためには、外部アプリケーションを Orchestrator に登録する必要があります。

If the external application is already registered, refer to Using OAuth for External Apps.