認証 API

認証 API を使用して、すべての Control Room API で承認に必要な JSON Web トークン (JWT) を生成、更新、管理することができます。

JWT は 703 字の文字列です。
{
  "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",  . . . 
}

auth

POST http://<your_control_room_url>/v1/authentication
本文パラメーター:
{
  "username": "string",
  "password": "string",
  "apiKey": "string",
  "mfaCode": 0
}
JWT を生成するためのポスト リクエストを作成します。
  • Automation Anywhere ユーザーのユーザー名。
  • Automation Anywhere ユーザーのパスワード。
  • apiKey は、シングル サインオン (SSO) を構成するために必要です。また、API キー生成ロールに割り当てられているユーザーのパスワードの代わりに使用することもできます。
  • mfaCode は、2 要素認証 (2FA) が有効になっているロールを持つユーザーに必要です。 「2 要素認証を有効にする」をご覧ください。
    注: ロールで 2FA を無効にするか、スクリプトや他のプログラム環境で使用するために 2FA を使用しない別のロールを作成することをお勧めします。プログラムで API リクエストを作成する場合、ユーザー名と apiKey を使用して認証する必要があります。セキュリティを向上させるため、プレーン テキスト形式のパスワードを使用しないでください。
注: 認証トークンのデフォルトのタイムアウトは 20 分です。
他の Control Room API のヘッダーには JWT が必要です。認証トークンの生成には、必要でないパラメーターもあります。詳細については、ここに記載されている例を参照してください。
注:

シンプルで保護された交渉 GSSAPI メカニズム (SPNEGO)

Control Room が次の認証機能で適切に設定されている場合は、SPNEGO を使用できます。
  • Active Directory (AD) モードの認証
  • AD は Kerberos が有効です

SPNEGO が適切に構成されている Control Room においては、ユーザーは JWT を生成するためにユーザー名とパスワードを入力する必要はありません。

SPNEGO 認証 API URL の例:https://<your_control_room_url/v1/authentication/SPNEGO

GET http://<your_control_room_url>/v1/authentication/token/{token}
URL パラメーター:
検証しているトークン。
注: トークンは URL のパラメータとして渡されます。このリクエスト本文には、パラメーターがありません。

タスクの詳細については、「認証トークンの検証」を参照してください。

POST http://<your_control_room_url>/v1/authentication/token
本文パラメーター:
更新トークンを使用すれば、トークンが期限切れになるたびに認証情報を収集して認証する必要なく、新しいトークンを取得できます。
{
  "token": "string"
}

この API の詳細な例については、認証トークンの更新 をクリックしてください。

POST http://<your_control_room_url>/v1/authentication/logout
ヘッダーパラメーター:
リクエストのヘッダーに追加したトークンは直ちに期限切れになります。
POST 'http://<your_control_room_url>/v1/authentication/logout'
-H 'X-Authorization: <access_token>

この API の詳細な例については、認証トークンをすぐにログアウト (期限切れに) する をクリックしてください。

POST http://<your_control_room_url>/v1/authentication/app/login
.../authentication/app/login API は、Automation Anywhere内部でサポートされているアプリケーションによって使用されるサービス認証 API へのサービスです。外部ユーザーは、この API を使用できません。