- スタート アップ ガイド
- 認証
- 範囲と権限
- プラットフォーム管理 API
セキュリティで保護された API 認証に使用する Automation Suite の個人用アクセス トークン (トークンの生成方法、サポートされているスコープ、ローカル ユーザーの可用性など)
個人用アクセス トークン (PAT) を使用すると、高レベルのセキュリティを維持しながら、UiPath のサービスやリソースに簡単にアクセスできます。
個人用アクセス トークンとは何ですか?
個人用アクセス トークンとは、UiPath の API やサービスを操作する際に資格情報の代わりに機能する、一意の英数字の文字列です。ユーザー名とパスワードを直接指定する代わりに、個人用アクセス トークンを生成することで特定の UiPath リソースに対して制御されたアクセスが付与されます。
PAT はローカル ユーザーのみが利用できます。ディレクトリ ユーザーや SAML では利用できません。
認証にトークンを使用するメリット
認証に個人用アクセス トークンを使用する主なメリットは、次のとおりです。
- セキュリティの強化: PAT はユーザー名とパスワードの代わりに使用されるため、プライマリ資格情報を公開するリスクが削減されます。
- きめ細かいアクセス制御: 範囲と権限を定めることで、各トークンのアクセスのレベルを正確に定義し、ユーザーのアクションを必要な対象に対してのみに制限できます。
- 有効期限: トークンに有効期限を割り当てることで、有効期間を制限できます。
トークンの範囲と権限
トークンの範囲は、トークンがアクセスできる特定のアクションやリソースを定義します。トークンを作成する際に、トークンの利用目的に基づいた適切な範囲を選択するよう求められます。範囲の例として以下が挙げられます。
TM.Defects.Read- Test Manager で、不具合の読み取りやアクセスに関連するアクションを実行できます。OR.Folders- Orchestrator で、フォルダー データの読み取り、フォルダーの作成、変更、管理を可能にします。
ニーズに適した範囲を選択する
個人用アクセス トークンを生成する際は、実行しようとするタスクに合う範囲を選択する必要があります。自身のユース ケースに必要な範囲のみを要求してください。トークンの権限を最小化することで、セキュリティ侵害を受けた場合に受ける影響を軽減し、セキュリティを強化します。
適切な範囲を選択するには、以下の手順を実行します。
- フォルダー データの読み取りやフォルダーの管理など、トークンに実行させる必要のあるタスクを決定します。
- トークン生成プロセスで利用可能な範囲とその説明のリストを確認します。
- トークンがタスクを効果的に達成できる最小限の範囲セットを選択します。
トークンを生成する
トークンを生成するには、以下の手順に従います。
-
ウィンドウの右上隅にあるユーザー アイコンを選択し、[設定] を選択します。 [設定] ページが開きます。
-
左側の [個人用アクセス トークン] を選択します。[個人用アクセス トークン] ページには、ユーザーに対して生成された個人用トークンのリストが表示されます (ある場合)。
-
新しいトークンを生成するには、[新しいトークンを生成] を選択します。右側に [個人用アクセス トークンを生成] ペインが開きます。
-
識別できるよう、[ 名前 ] フィールドに名前を入力します。
-
[有効期限] フィールドに有効期限を入力します。この日付を過ぎるとトークンが無効になります。
-
[ スコープ] > [リソース ] フィールドから範囲を選択し、トークンがアプリケーション内で実行を許可される特定の権限やアクションを定義します。
-
フィールドを設定したら、[ 保存 ] を選択してトークンを保存します。システムによって一意のアクセス トークンが生成されます。このトークンは [生成されたトークン ] ウィンドウに表示されます。
-
アクセス トークンが生成されたらすぐにコピーしてください。トークンが表示される機会はこの時だけです。再び確認することができないので、安全な場所に保管しておいてください。これで、このトークンを使用して、API を介して UiPath のリソースに認証を行いアクセスできるようになりました。
トークンを取り消す
トークンを取り消すと、不要になった、またはセキュリティ侵害を受けたトークンのアクセス権を直ちに無効化できます。トークンを取り消すには、以下の手順に従います。
-
ウィンドウの右上隅にあるユーザー アイコンを選択し、[設定] を選択します。 [設定] ページが開きます。
-
左側の [個人用アクセス トークン] を選択します。[個人用アクセス トークン] ページには、ユーザーに対して生成された個人用トークンのリストが表示されます。
-
トークンを取り消すには、特定のトークンの [その他のアクションを表示] > [取り消し] を選択します。[トークンを取り消し] ウィンドウが表示され、取り消しの確定を求められます。
-
トークンを取り消すには 、[削除 ] を選択します。削除すると、トークンは利用可能なトークンのリストから削除され、UiPath のリソースにアクセスするには無効になります。
重要:Orchestrator のキャッシュのメカニズムでは、PAT が 1 時間格納されます。その結果、取り消されたトークンは、キャッシュの有効期限が切れるまで、さらに 1 時間ほど Orchestrator のリソースにアクセスする可能性があります。
トークンの再生成
同じレベルのアクセス権を維持する必要があるが、トークンを更新したい場合は、個人用アクセス トークンを再生成することを検討してください。再生成により、元のトークンと同一のスコープと権限を持つ新しいトークンが作成されます。ただし、古いトークンを使用しているスクリプト、アプリケーション、または連携はすべて新しいトークンに更新してください。
再生成は、まだ有効期限が切れていないトークンにのみ適用できます。トークンの有効期限が切れると再生成できません。 Orchestrator のキャッシュのメカニズムでは、PAT が 1 時間格納されます。その結果、取り消されたトークンは、キャッシュの有効期限が切れるまで、さらに 1 時間ほど Orchestrator のリソースにアクセスする可能性があります。
トークンを再生成する
トークンを再生成するには、以下の手順に従います。
- ウィンドウの右上隅にあるユーザー アイコンを選択し、[設定] を選択します。 [設定] ページが開きます。
- 左側の [個人用アクセス トークン] を選択します。[個人用アクセス トークン] ページには、ユーザーに対して生成された個人用トークンのリストが表示されます。
- トークンを再生成するには、有効期限が切れていないトークンの [その他のアクションを表示] >[再生成] を選択します。[トークンを再生成] ウィンドウが表示されます。
- [ 確認 ] を選択してトークンを再生成します。システムによって一意のアクセス トークンが生成されます。このトークンは [生成されたトークン ] ウィンドウに表示されます。
- アクセス トークンが生成されたらすぐにコピーしてください。トークンが表示される機会はこの時だけです。再び確認することができないので、安全な場所に保管しておいてください。これで、このトークンを使用して、API を介して UiPath のリソースに認証を行いアクセスできるようになりました。