Automation Suite
2022.10
偽
- 基本情報
- 認証
- 範囲と権限
- プラットフォーム管理 API
UiPath Automation Suite API ガイド
最終更新日 2023年11月22日
認証
Automation Suite API では、要求ごとにアプリケーションから認証トークンを送信する必要があります。このトークンによってサーバーはユーザーの ID を検証できます。
Automation Suite のリソースにアクセスするには、次のいずれかの方法でアプリケーションを認証する必要があります。
- アプリケーションを登録して、認可トークンの取得に使用するクライアント ID とクライアント シークレットを生成する
authentication
エンドポイントの要求本文でリソース所有者の資格情報を提供する重要: 上記の認証方法は、リソースにアクセスするアプリケーションの信頼性が高い場合にのみ使用します。
認証に成功したら、特定のリソースへのアクセスを認可する (つまり、そのための適切な権限を付与する) 必要があります。アプリケーションへのアクセス許可は、API の
Authorization
ヘッダーを介して付与します。
重要:
ROPC による認証は、スタンドアロンから Automation Suite のデプロイに移行した Orchestrator インスタンスの後方互換性を確保するためにサポートされています。
/api/account/authenticate/
エンドポイントを使用して認証するのはホスト管理者だけにしてください。
ビジネス ユーザーは外部アプリケーションを使用して認証する必要があります。
リソース所有者のパスワード資格情報の認証方法はテナントが対象範囲であり、外部アプリケーションはテナント レベルで作成できないため、この方法では外部アプリを認証できません。
アクセス トークンを取得するには、次のペイロードを使用して
BaseURL/[OrgName]/[TenantName]/api/account/authenticate
エンドポイントに POST 要求を送信します。
{
"TenancyName": "{account_tenant_name}",
"UsernameOrEmailAddress": "{account_username}",
"Password": "{account_password}"
}
{
"TenancyName": "{account_tenant_name}",
"UsernameOrEmailAddress": "{account_username}",
"Password": "{account_password}"
}
上記の要求で、
{account_tenant_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
エンドポイントの呼び出しを行います。 - お使いの Automation Suite 組織が Azure Active Directory モデルを使用している場合は、Automation Suite に外部アプリケーションを登録して OAuth フローを使用する必要があります。