Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Embedded API
リソース

APIクライアント ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

次のエンドポイントを使用すると、カスタマーワークスペース内のAPIクライアントとクライアントロールを管理できます。 これらのエンドポイントを使用して、顧客向けの新しいAPIクライアントをプログラムで作成したり、APIトークンを定期的にローテーションしたりします。

レート制限 ​

APIクライアントリソースには、次のレート制限があります:

タイプリソース制限
GETDeveloper APIクライアントを一覧表示:
/api/v2/managed_users/:managed_user_id
/developer_api_clients		1分あたり1,000リクエスト
GETDeveloper APIクライアントロールを一覧表示:
/api/v2/managed_users/:managed_user_id
/developer_api_client_roles		1分あたり1,000リクエスト
すべてその他すべてのAPIクライアントエンドポイント1分あたり60リクエスト

クイックリファレンス ​

タイプリソース説明
GET/api/v2/managed_users/:managed_user_id/
developer_api_clients		カスタマーワークスペース内のDeveloper APIクライアントを一覧表示します。
POST/api/v2/managed_users/:managed_user_id/
developer_api_clients		カスタマーワークスペース内にDeveloper APIクライアントを作成します。
GET/api/v2/managed_users/:managed_user_id/
developer_api_clients/:id		カスタマーワークスペース内のDeveloper APIクライアントをIDで取得します。
PUT/api/v2/managed_users/:managed_user_id/
developer_api_clients/:id		カスタマーワークスペース内のDeveloper APIクライアントを更新します。
DELETE/api/v2/managed_users/:managed_user_id/
developer_api_clients/:id		カスタマーワークスペース内のDeveloper APIクライアントを削除します。
POST/api/v2/managed_users/:managed_user_id/
developer_api_clients/:id/regenerate		カスタマーワークスペース内のDeveloper APIクライアントトークンを再生成します。
GET/api/v2/managed_users/:managed_user_id/
developer_api_client_roles		顧客ワークスペース内のDeveloper APIクライアントロールを一覧表示します。
POST/api/v2/managed_users/:managed_user_id/
developer_api_client_roles/:id/copy		顧客ワークスペース内のDeveloper APIクライアントロールをコピーします。

Developer APIクライアントの一覧 ​

顧客ワークスペース内のすべてのDeveloper APIクライアントを一覧表示します。

GET /api/v2/managed_users/:managed_user_id/developer_api_clients

パスパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客IDまたは外部ID。
外部IDはURLエンコードし、Eのプレフィックスを付ける必要があります。例: EA2300。

クエリパラメーター ​

名前タイプ説明
pageinteger
optional		取得するAPIクライアントのページ番号。 デフォルトは1です。
per_pageinteger
optional		単一ページで返すAPIクライアントの数。 デフォルトは100です。 最大は100です。

サンプルリクエスト ​

shell
curl -X GET "https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients" \
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "result": {
        "count": 1,
        "items": [
            {
                "id": 40947,
                "name": "Test",
                "api_privilege_group_id": 26779,
                "created_at": "2023-02-22T01:55:35.739-08:00",
                "updated_at": "2023-02-28T01:23:18.046-08:00",
                "all_folders": false,
                "folder_ids": [
                    26138,
                    26136
                ],
                "environment_name": "Development",
                "environment_id": 3218,
                "ip_allow_list": "192.0.2.10,198.51.100.5",
                "token": {
                    "updated_at": "2023-02-22T09:55:36.427Z"
                }
            }
        ]
    }
}

Developer APIクライアントの作成 ​

カスタマーワークスペース内にDeveloper APIクライアントを作成します。

POST /api/v2/managed_users/:managed_user_id/developer_api_clients

パスパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客IDまたは外部ID。
外部IDはURLエンコードし、Eのプレフィックスを付ける必要があります。例: EA2300。

リクエスト本文 ​

名前タイプ説明
namestring
必須		APIクライアントの名前
api_privilege_group_idinteger
required		APIクライアントロールのID。
all_foldersboolean
必須		クライアントがすべてのフォルダにアクセスできるかどうかを示します。 true、false、1、または0である必要があります。
folder_idsarray
conditional		フォルダIDのリスト。 all_foldersがfalseの場合は必須です。
environment_namestring
conditional		Environmentの名前。 ワークスペースでEnvironmentが有効になっている場合は必須です。
ip_allow_liststring
任意		APIクライアントへのアクセスを許可されたIPアドレスの配列。 指定しない場合、デフォルトですべてのIPになります。

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Test Client",
            "api_privilege_group_id": 26779,
            "environment_name": "Development",
            "all_folders": true,
            "ip_allow_list": "192.0.2.10,198.51.100.5"
          }'

レスポンス ​

json
{
    "result": {
        "id": 40948,
        "name": "Test Client",
        "api_privilege_group_id": 26779,
        "created_at": "2023-02-28T02:09:07.255-08:00",
        "updated_at": "2023-02-28T02:09:07.586-08:00",
        "all_folders": true,
        "environment_name": "Development",
        "environment_id": 3218,
        "ip_allow_list": "192.0.2.10,198.51.100.5",
        "token": {
            "updated_at": "2023-02-28T10:09:07.579Z",
            "value": "wrkaus-eyJhbGciOiJSUz..."
        }
    }
}

IDによるDeveloper APIクライアントの取得 ​

カスタマーワークスペース内のDeveloper APIクライアントをIDで取得します。

GET /api/v2/managed_users/:managed_user_id/developer_api_clients/:id

パスパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客IDまたは外部ID。
外部IDはURLエンコードし、Eのプレフィックスを付ける必要があります。例: EA2300。
idinteger
required		APIクライアントのID。

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948 \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "result": {
        "id": 40948,
        "name": "Test Client",
        "api_privilege_group_id": 26779,
        "created_at": "2023-02-28T02:09:07.255-08:00",
        "updated_at": "2023-02-28T02:09:07.586-08:00",
        "all_folders": false,
        "folder_ids": [26138, 26136],
        "environment_name": "Development",
        "environment_id": 3218,
        "token": {
            "updated_at": "2023-02-28T10:09:07.579Z"
        }
    }
}

Developer APIクライアントの更新 ​

カスタマーワークスペース内のDeveloper APIクライアントを更新します。

PUT /api/v2/managed_users/:managed_user_id/developer_api_clients/:id

パスパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客IDまたは外部ID。
外部IDはURLエンコードし、Eのプレフィックスを付ける必要があります。例: EA2300。
idinteger
required		APIクライアントのID。

リクエスト本文 ​

名前タイプ説明
namestring
任意		APIクライアントの更新後の名前
api_privilege_group_idinteger
optional		更新後のAPIクライアントロールID
all_foldersboolean
optional		クライアントがすべてのフォルダにアクセスできるかどうかを示します。 true、false、1、または0である必要があります。
folder_idsarray
conditional		フォルダIDの配列。 all_foldersがfalseの場合は必須です。
environment_namestring
conditional		Environmentの名前。 ワークスペースでEnvironmentが有効になっている場合は必須です。
ip_allow_liststring
任意		APIクライアントへのアクセスを許可されたIPアドレスの配列。 指定しない場合、デフォルトですべてのIPになります。

サンプルリクエスト ​

shell
curl  -X PUT https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948 \
      -H 'Authorization: Bearer <api_token>'  \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Test Client",
            "api_privilege_group_id": 26779,
            "environment_name": "Development",
            "all_folders": true,
            "ip_allow_list": "192.0.2.10,198.51.100.5"
          }'

レスポンス ​

json
{
    "result": {
        "id": 40948,
        "name": "Test Client",
        "api_privilege_group_id": 26779,
        "created_at": "2023-02-28T02:09:07.255-08:00",
        "updated_at": "2023-02-28T02:09:07.586-08:00",
        "all_folders": true,
        "environment_name": "Development",
        "environment_id": 3218,
        "ip_allow_list": "192.0.2.10,198.51.100.5",
        "token": {
            "updated_at": "2023-02-28T10:09:07.579Z"
        },
        "user": {
            "id": 3218,
            "name": "Workato Customer Success test"
        }
    }
}

Developer APIクライアントの削除 ​

カスタマーワークスペース内のDeveloper APIクライアントを削除します。

DELETE /api/v2/managed_users/:managed_user_id/developer_api_clients/:id

パスパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客IDまたは外部ID。
外部IDはURLエンコードし、Eのプレフィックスを付ける必要があります。例: EA2300。
idinteger
required		APIクライアントのID。

サンプルリクエスト ​

shell
curl  -X DELETE https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948 \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "result": "success"
}

Developer APIクライアントトークンの再生成 ​

カスタマーワークスペース内のAPIクライアントのAPIトークンを再生成します。 これにより、以前のAPIトークンが無効になります。

POST /api/v2/managed_users/:managed_user_id/developer_api_clients/:id/regenerate

パスパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客IDまたは外部ID。
外部IDはURLエンコードし、Eのプレフィックスを付ける必要があります。例: EA2300。
idinteger
required		APIクライアントのID。

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948/regenerate \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "result": {
        "id": 40948,
        "name": "Test new API client",
        "api_privilege_group_id": 26779,
        "created_at": "2023-01-29T22:30:12.930-08:00",
        "updated_at": "2023-02-28T02:19:16.542-08:00",
        "all_folders": true,
        "environment_name": "Development",
        "environment_id": 3218,
        "token": {
            "updated_at": "2023-02-28T10:19:16.530Z",
            "value": "wrkaus-eyJhbGc..."
        }
    }
}

Developer APIクライアントロールの一覧 ​

カスタマーワークスペース内のDeveloper APIクライアントロールのリストを返します。

text
GET /api/v2/managed_users/:managed_user_id/developer_api_client_roles

パスパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客IDまたは外部ID。
外部IDはURLエンコードし、Eのプレフィックスを付ける必要があります。例: EA2300。

クエリパラメータ ​

名前タイプ説明
pageinteger
optional		ページ番号。 デフォルトは1です。
per_pageinteger
optional		ページサイズ。 デフォルトは100です。 最大値は100です。

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/v2/managed_users/E1234/developer_api_client_roles \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "data": [
        {
            "id": 416281,
            "name": "Read-only API client",
            "created_at": "2025-09-10T09:17:48.292-07:00",
            "updated_at": "2025-09-10T09:17:48.292-07:00"
        },
        {
            "id": 416282,
            "name": "Full-access API client",
            "created_at": "2025-09-10T09:17:54.676-07:00",
            "updated_at": "2025-09-10T09:18:02.740-07:00"
        }
    ],
    "count": 2,
    "page": 1,
    "per_page": 100
}

Developer APIクライアントロールのコピー ​

Embedded顧客のDeveloper APIクライアントロールのコピーを作成します。

text
POST /api/v2/managed_users/:managed_user_id/developer_api_client_roles/:id/copy

パスパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客IDまたは外部ID。
外部IDはURLエンコードし、Eのプレフィックスを付ける必要があります。例: EA2300。
idinteger
required		コピーするDeveloper APIクライアントロールのID。

リクエスト本文 ​

名前タイプ説明
namestring
必須		コピーされたDeveloper APIクライアントロールに割り当てられる名前。

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/v2/managed_users/E1234/developer_api_client_roles/416281/copy \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Read-only API client (copy)"
          }'

レスポンス ​

json
{
    "data": {
        "id": 416283,
        "name": "Read-only API client (copy)",
        "created_at": "2025-09-10T09:21:14.459-07:00",
        "updated_at": "2025-09-10T09:21:14.459-07:00"
    }
}

Last updated: