新規ユーザーを作成

Control Room で新規ユーザーを作成するには、新規ユーザーを作成 API を使用します。

前提条件

ユーザーの表示と管理

次の管理権限を持つユーザーによる認証:

  • ユーザーを表示

    これらの権限を持つユーザーは、ユーザーを作成して管理できます。これらは管理者の権限です。管理者以外のユーザーには、ユーザーの作成および管理について限定的な権限を与えることが推奨されます。ユーザーに割り当てることができる限定的な権限を持つロールを作成する

    方法を学びます。
    • ユーザーを作成
    • ユーザーを編集
    • ユーザーを削除
  • ライセンスを表示

    これらの権限を持つユーザーは、デバイス ライセンスを表示して管理できます。ユーザーが特定のタスクを実行できるようにするには、デバイス ライセンスが必要です。たとえば、Bot CreatorBot を作成するには、開発デバイス ライセンスが必要です。

    ユーザーのデバイス ライセンスを管理

JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。「認証 API」をご覧ください。
最小必須パラメータ
  • ロール: 各ユーザーには、少なくとも 1 つのロールが必要です。ユーザー管理 API からロールを作成するには、ロール ID が必要です。

    ロール ベースのアクセシビリティにより、関連するデータとアクションへの適切なアクセスが可能になります。

    注: この例では、Bot Creator ユーザーを作成しました。リクエスト本文では、以下の システムによって作成されるロール を割り当てました。
    • AAE_Basic (ID: 2)
    • AAE_Meta Bot Designer (ID: 13)
  • username: 文字列 (最大 255 文字)
  • email: 標準 E メール形式に準拠する必要があります (username@domain.com)
  • パスワード: 文字列: 長さ 8~15 文字。使用可能な文字: a-z、A-Z、0-9、@、-、_、!、#、$、%、&、および . (ピリオド)
追加の推奨パラメーター
  • "enableAutoLogin": true
  • "username": "NumerOneUser"
  • "firstName": "Doc"
  • "lastName": "Writer"
  • "email": "username@mydomain.com"
  • "password": "changeme"
  • "description": "Test user creation."
  • "licenseFeatures": [ DEVELOPMENT, RUNTIME, IQBOTRUNTIME, ANALYTICSCLIENT, ANALYTICSAPI ]

    ユーザーは、デバイス ライセンスを割り当てられていなくても作成できます。特定のユーザーおよびロールの権限が有効になっている システムのデフォルト ライセンス があります。

  • API をテストするには、Control Room と一緒にインストールされた Swagger を使用します。利用可能な API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    認証 API を使用して JSON Web トークンを生成します。「認証 API」をご覧ください。
  2. [POST] メソッドを選択します。
    POST http://<your_control_room_url>/v1/usermanagement/users
  3. リクエスト本文で、必須パラメーターを入力し、パラメーターを推奨します。

    リクエスト本文:

    {
      "roles": [
        {
          "id": 2
        },
        {
          "id": 13
        }
      ],
      "enableAutoLogin": true,
      "username": "BotCreatorUser",
      "firstName": "Robert",
      "lastName": "Developer",
      "email": "bob.dev@mydomain.com",
      "password": "changeme",
      "description": "Go create great bots.",
      "licenseFeatures": [
        "DEVELOPMENT"
      ]
    }
  4. リクエストを送信します。
    • Swagger で、[実行] をクリックします。
    • REST Client で SEND をクリックします。

    レスポンスはユーザーの詳細を返します。

    レスポンス本文:
    {
      "id": 61,
      "email": "bob.dev@mydomain.com",
      "username": "botcreatoruser",
      "domain": null,
      "firstName": "Robert",
      "lastName": "Developer",
      "version": 0,
      "principalId": 61,
      "deleted": false,
      "roles": [
        {
          "name": "AAE_Basic",
          "id": 2,
          "version": 0
        },
        {
          "name": "AAE_Meta Bot Designer",
          "id": 13,
          "version": 0
        }
      ],
      "sysAssignedRoles": [],
      "groupNames": [],
      "permissions": [
        {
          "id": 97,
          "action": "viewbotstore",
          "resourceId": null,
          "resourceType": "botstore"
        },
        {
          "id": 33,
          "action": "upload",
          "resourceId": "7",
          "resourceType": "repositorymanager"
        },
        {
          "id": 61,
          "action": "createstandard",
          "resourceId": null,
          "resourceType": "credentialattribute"
        },
        {
          "id": 93,
          "action": "download",
          "resourceId": "9",
          "resourceType": "repositorymanager"
        },
        {
          "id": 134,
          "action": "viewuserbasic",
          "resourceId": null,
          "resourceType": "usermanagement"
        },
        {
          "id": 29,
          "action": "view",
          "resourceId": null,
          "resourceType": "repositorymanager"
        },
        {
          "id": 62,
          "action": "metabotdesigner",
          "resourceId": null,
          "resourceType": "metabot"
        },
        {
          "id": 34,
          "action": "download",
          "resourceId": "7",
          "resourceType": "repositorymanager"
        },
        {
          "id": 92,
          "action": "upload",
          "resourceId": "9",
          "resourceType": "repositorymanager"
        }
      ],
      "licenseFeatures": [
        "DEVELOPMENT"
      ],
      "emailVerified": true,
      "passwordSet": false,
      "questionsSet": false,
      "enableAutoLogin": true,
      "disabled": false,
      "clientRegistered": false,
      "description": "Go create great bots.",
      "createdBy": 19,
      "createdOn": "2020-02-09T23:25:20Z",
      "updatedBy": 19,
      "updatedOn": "2020-02-09T23:25:20Z",
      "publicKey": null,
      "appType": null,
      "routingName": null,
      "appUrl": null
    }
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X POST -H 'X-Authorization: <authentication_token>' -i '<your_control_room_url>/v1/usermanagement/users' --data '{
  "roles": [
    {
      "id": 2
    },
    {
      "id": 13
    }
  ],
  "enableAutoLogin": true,
  "username": "BotCreatorUser",
  "firstName": "Robert",
  "lastName": "Developer",
  "email": "bob.dev@mydomain.com",
  "password": "changeme",
  "description": "Go create great bots.",
  "licenseFeatures": [
   "DEVELOPMENT"
  ]
}'

次のステップ

  • 作成されたユーザーとして Control Room にログインすることによって、ユーザーが作成されたことを確認できます。
  • システム割り当てロール sySassigneDroles には、ユーザーに割り当てたロール、およびすべてのユーザーに割り当てたデフォルトのロールに要求される一連の権限が含まれます。