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

Automation Anywhere Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

ユーザー API の検索

  • 更新済み: 1/28/2021
    • Automation 360 v.x
    • 管理
    • RPA Workspace
    • API ドキュメント

ユーザー API の検索

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

前提条件

管理者ロールまたは [ユーザーを表示] 権限を持つカスタム ロールがあることを確認します。

手順

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

    リクエスト本文:

    {
      "fields": [],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "substring",
            "field": "username",
            "value": "mdadmin"
          },
          {
            "operator": "gt",
            "field": "createdOn",
            "value": "2020-09-01T00:00:00.989Z"
          },
          {
            "operator": "lt",
            "field": "createdOn",
            "value": "2020-09-06T23:00:00.123Z"
          }
        ]
      }
    }
  4. リクエストを送信します。

    次のリクエストは、2020 年 9 月 1 日から 9 月 6 日までに作成され、usernameadmin を含むすべてのユーザーを検索します。

    レスポンス本文:
    {
      "page": {
        "offset": 0,
        "total": 310,
        "totalFilter": 2
      },
      "list": [
        {
          "id": 1513,
          "username": "mdadmin",
          "domain": "",
          "firstName": "MD_tester",
          "lastName": "MD_user",
          "version": 17,
          "principalId": 1513,
          "email": "md@aa.com",
          "emailVerified": true,
          "passwordSet": true,
          "questionsSet": true,
          "enableAutoLogin": false,
          "disabled": false,
          "clientRegistered": false,
          "description": "To be used for API testing",
          "createdBy": 1,
          "createdOn": "2020-09-01T11:01:17.760Z",
          "updatedBy": 1,
          "updatedOn": "2020-09-01T11:01:17.760Z",
          "licenseFeatures": [],
          "roles": [
            {
              "id": 1,
              "name": "AAE_Admin"
            },
            {
              "id": 2,
              "name": "AAE_Basic"
            }
          ],
          "deleted": false
        },
        {
          "id": 1520,
          "username": "mt_admin",
          "domain": "",
          "firstName": "",
          "lastName": "",
          "version": 6,
          "principalId": 1520,
          "email": "a@a.com",
          "emailVerified": true,
          "passwordSet": true,
          "questionsSet": true,
          "enableAutoLogin": false,
          "disabled": false,
          "clientRegistered": false,
          "description": "",
          "createdBy": 1,
          "createdOn": "2020-09-02T08:47:19.723Z",
          "updatedBy": 1,
          "updatedOn": "2020-09-02T08:47:19.723Z",
          "licenseFeatures": [],
          "roles": [
            {
              "id": 1,
              "name": "AAE_Admin"
            }
          ],
          "deleted": false
        }
      ]
    }

    このレスポンスは、adminmdadminmt_admin を含む 2 つのユーザー名のデータを返します。

    レスポンス パラメーター:
    パラメーター名 説明
    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 API は、HTTP レスポンス コードで各リクエストに応答します。レスポンス コードの詳細は、API レスポンス コード を参照してください。
フィードバックを送る