ユーザー名apiKey で認証

Control Room API での認証に使用する JSON Web トークン (JWT) を生成するには、ユーザー名API を使用して POST リクエストを作成します。

前提条件

  • API キーの生成ロールを持っているユーザー。
    注: API キーを生成機能には、カスタム ロールを作成する必要があります。API キー生成に関するロールの作成と割り当て を参照してください。
  • API キーを生成
  • Control Room のための有効なユーザー名apiKey
  • REST Client または Control RoomAutomation Anywhere への Swagger ファイルへのアクセス
  • URL: http://<your_control_room_url>/v1/authentication
  • メソッド: POST

API キーの生成 を使用すれば、ユーザー認証情報を収集する必要なくトークンを作成できます。

手順

  1. 次のパラメーターをリクエスト本文に指定します。
    リクエスト本文:
    注: API キーは 40 字の文字列です。
    {
    "username": "jdoe",
    "apiKey":  "3/.Z)8:P`+yVJq . . . *fTk.i>|VOOl&:"
    }
    
    Control Room の構成方法によっては、ユーザー名でドメインが必要になることがあります。
    {
    "username": "your-domain\\jdoe",
    "apiKey":  "3/.Z)8:P`+yVJq . . . *fTk.i>|VOOl&:"
    }
    
    注: 管理者ユーザーは、管理 > 設定 > 全般タブから API キーの期間を設定できます。
  2. リクエストを送信します。
    • REST Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。
    レスポンス本文:
    注:
    注: JWT は 703 字の文字列です。
    {
      "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": "",
        "lastName": "",
        "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
          },
          {
            "name": "AAE_Meta Bot Designer",
            "id": 13,
            "version": 0
          }
        ],
        "sysAssignedRoles": [],
        "groupNames": [],
        "permissions": [
    
    	. . .
    
        ],
        "licenseFeatures": [
          "RUNTIME"
        ],
        "emailVerified": true,
        "passwordSet": true,
        "questionsSet": true,
        "enableAutoLogin": false,
        "disabled": false,
        "clientRegistered": false,
        "description": "",
        "createdBy": 1,
        "createdOn": "2019-10-10T13:39:56-05:00",
        "updatedBy": 1,
        "updatedOn": "2019-10-13T02:09:38-05:00",
        "publicKey": null,
        "appType": null,
        "routingName": null,
        "appUrl": null
      }
    }