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

Automation Anywhere バージョン11.3

コンテンツを閉じる

コンテンツ

コンテンツを開く

ユーザーの検索

  • 更新済み: 5/06/2020
    • 11.3.x
    • 最新情報
    • Enterprise
    • API ドキュメント

ユーザーの検索

ユーザーの検索 APIを使用して、Control Room にあるすべてのユーザーを検索します。

前提条件

ユーザーを表示
ユーザーの表示権限を持っているユーザーは、すべてのユーザーを取得できます。
JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。「認証 API」をご覧ください。
  • URL: http://<your_control_room_url>/v1/usermanagement/users/list

    角括弧内のコンテンツを Control Room の URL に置き換えます。

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

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    認証 API を使用して JSON Web トークンを生成します。「認証 API」をご覧ください。
  2. [POST] メソッドを選択します。
    フィルターを適用して、Web ページの基本的な条件付きクエリおよび改ページの制御を実行します。フィルタリングには、フィルタリングの条件、列の並び替え、改ページ パラメーターという 3 つの基本的な機能があります。「API リクエスト本文でフィルタリング」をご覧ください。
    POST http://<your_control_room_url>/v1/usermanagement/users/list
  3. リクエストを送信します。
    • REST Client で SEND をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    リクエスト本文:

    次のリクエストは、2019 年 12 月 1 日から 12 月 31 日までに作成され、usernamedoc を含むすべてのユーザーを検索します。
    {
      "fields": [],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "substring",
            "field": "username",
            "value": "doc"
          },
          {
            "operator": "gt",
            "field": "createdOn",
            "value": "2019-12-01T00:00:00.989Z"
          },
          {
            "operator": "lt",
            "field": "createdOn",
            "value": "2019-12-06T23:00:00.123Z"
          }
        ]
      }
    }

    この例のレスポンスでは、doc ユーザー名のデータが返されます。

    レスポンス本文:
    {
      "page": {
        "offset": 0,
        "total": 24,
        "totalFilter": 5
      },
      "list": [{
        "id": 29,
        "username": "docs-2fa-vm1",
        "domain": "",
        "firstName": "",
        "lastName": "",
        "version": 2,
        "principalId": 29,
        "email": "tm@automationanywhere.com",
        "emailVerified": true,
        "passwordSet": true,
        "questionsSet": true,
        "enableAutoLogin": true,
        "disabled": false,
        "clientRegistered": true,
        "description": "",
        "createdBy": 4,
        "createdOn": "2019-12-05T05:24:49.330Z",
        "updatedBy": 0,
        "updatedOn": "2019-12-05T05:27:58.687Z",
        "licenseFeatures": ["DEVELOPMENT"],
        "roles": [{
          "id": 31,
          "name": "2fa-role-basic-bot-permission",
          "version": "0"
        }],
        "deleted": false
      }, {
        "id": 30,
        "username": "docs-test-02",
        "domain": "",
        "firstName": "",
        "lastName": "",
        "version": 0,
        "principalId": 30,
        "email": "a@a.com",
        "emailVerified": true,
        "passwordSet": false,
        "questionsSet": false,
        "enableAutoLogin": true,
        "disabled": false,
        "clientRegistered": false,
        "description": "Docs resource",
        "createdBy": 4,
        "createdOn": "2019-12-05T23:15:53.907Z",
        "updatedBy": 4,
        "updatedOn": "2019-12-05T23:15:53.907Z",
        "licenseFeatures": ["RUNTIME", "IQBOTRUNTIME"],
        "roles": [{
          "id": 2,
          "name": "AAE_Basic",
          "version": "0"
        }, {
          "id": 13,
          "name": "AAE_Meta Bot Designer",
          "version": "0"
        }],
        "deleted": false
      }, {
        "id": 31,
        "username": "docs-test-04",
        "domain": "",
        "firstName": "",
        "lastName": "",
        "version": 0,
        "principalId": 31,
        "email": "a@a.com",
        "emailVerified": true,
        "passwordSet": false,
        "questionsSet": false,
        "enableAutoLogin": true,
        "disabled": false,
        "clientRegistered": false,
        "description": "Docs resource",
        "createdBy": 4,
        "createdOn": "2019-12-05T23:16:26.543Z",
        "updatedBy": 4,
        "updatedOn": "2019-12-05T23:16:26.543Z",
        "licenseFeatures": ["RUNTIME", "IQBOTRUNTIME"],
        "roles": [{
          "id": 2,
          "name": "AAE_Basic",
          "version": "0"
        }, {
          "id": 13,
          "name": "AAE_Meta Bot Designer",
          "version": "0"
        }],
        "deleted": false
      }, {
        "id": 32,
        "username": "docs-user-md",
        "domain": "",
        "firstName": "",
        "lastName": "",
        "version": 0,
        "principalId": 32,
        "email": "a@a.com",
        "emailVerified": true,
        "passwordSet": false,
        "questionsSet": false,
        "enableAutoLogin": true,
        "disabled": false,
        "clientRegistered": false,
        "description": "Docs resource",
        "createdBy": 4,
        "createdOn": "2019-12-05T23:45:44.267Z",
        "updatedBy": 4,
        "updatedOn": "2019-12-05T23:45:44.267Z",
        "licenseFeatures": ["RUNTIME", "IQBOTRUNTIME"],
        "roles": [{
          "id": 2,
          "name": "AAE_Basic",
          "version": "0"
        }, {
          "id": 13,
          "name": "AAE_Meta Bot Designer",
          "version": "0"
        }],
        "deleted": false
      }, {
        "id": 33,
        "username": "docs-tm-admin",
        "domain": "",
        "firstName": "",
        "lastName": "",
        "version": 2,
        "principalId": 33,
        "email": "tr@automationanywhere.com",
        "emailVerified": true,
        "passwordSet": true,
        "questionsSet": true,
        "enableAutoLogin": false,
        "disabled": false,
        "clientRegistered": false,
        "description": "",
        "createdBy": 4,
        "createdOn": "2019-12-06T19:05:36.217Z",
        "updatedBy": 4,
        "updatedOn": "2019-12-06T19:07:21.097Z",
        "licenseFeatures": [],
        "roles": [{
          "id": 33,
          "name": "apiKey-Docs",
          "version": "0"
        }, {
          "id": 1,
          "name": "AAE_Admin",
          "version": "0"
        }],
        "deleted": false
      }]
    }
    レスポンス本文のパラメーター:
    パラメーター名 説明
    id ユーザーを作成したシステム生成 ID 番号。
    username 新規ユーザーのユーザー名。
    domain Active Directory ドメイン名。
    version 新規ユーザーのシステム生成バージョン番号。
    email 新規ユーザーの E メールアドレス。
    passwordSet 文字列: a-z、A-Z、0-9、@、-、 _、!、#、$、%、&、. (ピリオド) を含む 8~15 文字。新規ユーザー専用のパスワードを設定します。
    PrincipalId 新規ユーザーを作成した Active Directory プリンシパル ユーザーのシステム生成 ID 番号。
    Permission 特定の権限 ID。
    licenseFeature Automation Anywhere このロールに関連付けられたライセンス。
    Roles: id このユーザーに関連付けられたシステム生成によるロール ID 番号。すべてのユーザーにロールが関連付けられるわけではありません。
    createdBy 新規ユーザーを作成した管理者ユーザーのシステム生成による ID 番号。
    updatedBy ユーザーを更新した管理者ユーザーのシステム生成による ID 番号。
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X POST "http://<your_control_room_url>/v1/usermanagment/users/list" 
-H "accept: application/json" 
-H "X-Authorization: <authentication_token>" 
-H "Content-Type: application/json" -d "{
  "fields": [],
  "filter": {
    "operator": "and",
    "operands": [
      {
        "operator": "substring",
        "field": "username",
        "value": "doc"
      },
      {
        "operator": "gt",
        "field": "createdOn",
        "value": "2019-12-01T00:00:00.989Z"
      },
      {
        "operator": "lt",
        "field": "createdOn",
        "value": "2019-12-06T23:00:00.123Z"
      }
    ]
  }
}'
フィードバックを送る