Automation Anywhere ドキュメントを読んで確認する

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

(username と apiKey) で認証

  • 更新済み: 2022/08/18
    • Automation 360 v.x
    • マネージ
    • RPA Workspace
    • API ドキュメント

(username と apiKey) で認証

この API を使用し、usernameapikey を使用して、Control Room へのアクセスを認証します。正常にレスポンスされた場合は、JSON Web トークンが生成されます。生成されたトークンは 20 分間有効です。シングル サインオン (SSO) を使用する組織などでは、ユーザーのパスワードを必要とせずにトークンを生成することができます。

トークンを生成するには、以下が必要です。

リクエスト

POST http://{{ControlRoomURL}}/v1/authentication
リクエスト本文:
{
   "username":"jdoe",
   "apiKey":"Vie;Z:IvtAhY0\\1RAD[SWl{NU7baRLYEeIYUJSKO"
}
注: apiKey でマルチ セッション トークンを生成します。apiKey でログインしている場合は、multipleLogin パラメーターは適用されません。

リクエスト パラメーター

パラメーター タイプ 説明
ユーザー名 文字列 ユーザー名を入力します。
apikey 文字列 apikey を入力します。
注: .24 以前のバージョンでは、API キーのエスケープ文字「\」を「\\」に置き換える必要があります。.25 以降のバージョンでは、API キーにエスケープ文字 (「\」) がなくなりました。

レスポンス

{
   "token":"eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",
   "user":{
      "id":9,
      "email":"a@a.com",
      "username":"jdoe",
      "domain":null,
      "firstName":"j",
      "lastName":"doe",
      "version":9,
      "principalId":9,
      "deleted":false,
      "roles":[
         {
            "name":"API_Key_Generation",
            "id":23,
            "version":0
         },
         {
            "name":"AAE_Basic",
            "id":2,
            "version":0
         },
         {
            "name":"Docrole1",
            "id":18,
            "version":0
         }
      ],
      "sysAssignedRoles":[
         
      ],
      "groupNames":[
         
      ],
      "permissions":[
         ". . ."
      ],
      "licenseFeatures":[
         "RUNTIME"
      ],
      "emailVerified":true,
      "passwordSet":true,
      "questionsSet":true,
      "enableAutoLogin":false,
      "disabled":false,
      "clientRegistered":false,
      "description":"",
      "createdBy":1,
      "createdOn":"2022-03-10T13:39:56-05:00",
      "updatedBy":1,
      "updatedOn":"2022-03-13T02:09:38-05:00",
      "publicKey":null,
      "appType":null,
      "routingName":null,
      "appUrl":null
   }
}

レスポンス パラメーター

パラメーター タイプ 説明
トークン 文字列 生成されたアクセス トークン。アプリケーションがリクエストを行う際に使用するセッション ID として機能します。このトークンはユーザー資格情報と同等であり、保護される必要があります。
ユーザー オブジェクト ユーザーのすべての詳細情報を含む、返されたユーザー オブジェクト。
  • id - ユーザーの ID。
  • email - ユーザーの E メール ID。
  • username - ユーザーの名前。
  • domain - ログインしているドメイン。
  • firstname - ユーザーの名。
  • lastname - ユーザーの姓。
  • roles - ユーザーに割り当てられたロール。
  • sysAssignedRoles - システムによって割り当てられたロール。
  • permissions - ユーザーに割り当てられた許可。
  • licenseFeatures - ユーザーに割り当てられたライセンス。

後続の API リクエストのリクエスト ヘッダーにトークンを挿入します。

フィードバックを送る