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

Embedded API - カスタマーマネージャー ​

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

次のエンドポイントを使用して、カスタマーマネージャーをプログラムで管理します。

レート制限 ​

カスタマーマネージャーリソースには、次のレート制限があります:

タイプリソース制限
すべてすべての顧客マネージャーエンドポイント1分あたり60リクエスト

クイックリファレンス ​

タイプリソース説明
GET/api/customer_managersすべてのカスタマーマネージャーを一覧表示します。
PUT/api/customer_managers/:idカスタマーマネージャーを更新します。
POST/api/customer_managers新しいカスタマーマネージャーを作成します。
DELETE/api/customer_managers/:idカスタマーマネージャーを削除します。

カスタマーマネージャーを一覧表示 ​

Embeddedパートナーのアカウント内のすべてのカスタマーマネージャーのリストを返します。

Embeddedパートナーのアカウント内のすべてのワークスペースにアクセスできるカスタマーマネージャーの場合、moderated_workspacesは空の配列（[]）です。

shell
GET /api/customer_managers

サンプルリクエスト ​

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

レスポンス ​

json
{
    "result": {
        "items": [
            {
                "id": 1234,
                "user": {
                    "id": 4321,
                    "name": "ACME-HR",
                    "email": "[email protected]",
                    "avatar_url": "https://example.com"
                },
                "privilege_group": {
                    "id": 247,
                    "name": "Customer Admin",
                    "system": false
                },
                "moderated_workspaces": [
                    {
                        "id": 27123,
                        "name": "Nutech"
                    },
                    {
                        "id": 29456,
                        "name": "ACME USA"
                    }
                ],
                "project_role": {
                    "id": "pr-AQRtExgY-cEGWTN",
                    "name": "Builder"
                }
            },
            {
                "id": 5678,
                "user": {
                    "id": 8765,
                    "name": "ACME Corp.",
                    "email": "[email protected]",
                    "avatar_url": "https://example.com"
                },
                "privilege_group": {
                    "id": 2,
                    "name": "Admin",
                    "system": true
                },
                "moderated_workspaces": [],
                "project_role": {
                    "id": "pr-AQRtExgY-cEGWTN",
                    "name": "Builder"
                }
            }
        ]
    }
}

カスタマーマネージャーを更新 ​

Embeddedパートナーのアカウント内のカスタマーマネージャーのロールを更新します。

shell
PUT /api/customer_managers/:id

URLパラメーター ​

名前タイプ説明
idstring
必須		ロールの更新対象となるカスタマーマネージャーのID。

リクエスト本文 ​

名前タイプ説明
role_idstring
必須		カスタマーマネージャーに割り当てるレガシーロール。
project_role_idstring
任意		カスタマーマネージャーに割り当てるプロジェクトロール。
permitted_workspace_idsarray of integers
optional		指定したrole_idに従って、カスタマーマネージャーに指定のロールを付与するワークスペースIDのリスト。

省略した場合、または空の配列（[]）に設定した場合、このパラメーターはEmbeddedパートナーのアカウント内の_すべての_ワークスペースで、カスタマーマネージャーに指定のロールを付与します。

サンプルリクエスト ​

shell
curl  -X PUT 'https://www.workato.com/api/customer_managers/1234' \
      -H 'Authorization: Bearer <api_token>'\
      -H 'Content-Type: application/json' \
      -d  '{
            "role_id": "2",
            "permitted_workspace_ids": [29456,27123],
            "project_role_id": "pr-AQRtExgY-cEGWTN"
           }'

レスポンス ​

json
{
    "result": {
        "id": 1234,
        "user": {
            "id": 4321,
            "name": "Alex",
            "email": "[email protected]",
            "avatar_url": ""
        },
        "privilege_group": {
            "id": 2,
            "name": "Admin",
            "system": true
        },
        "moderated_workspaces": [
            {
                "id": 29456,
                "name": "ACME USA"
            },
            {
                "id": 27123,
                "name": "Nutech"
            }
        ],
        "project_role": {
            "id": "pr-AQRtExgY-cEGWTN",
            "name": "Builder"
        }
    }
}

カスタマーマネージャーを作成 ​

Embeddedパートナーのアカウント内に新しいカスタマーマネージャーを作成します。

shell
POST /api/customer_managers

リクエスト本文 ​

名前タイプ説明
team_collaborator_idstring
必須		コラボレーターのID。
role_idstring
必須		カスタマーマネージャーに割り当てるレガシーロール。
project_role_idstring
任意		カスタマーマネージャーに割り当てるプロジェクトロール。
permitted_workspace_idsarray of integers
optional		指定したrole_idに従って、カスタマーマネージャーに指定のロールを付与するワークスペースIDのリスト。

省略した場合、または空の配列（[]）に設定した場合、このパラメーターはEmbeddedパートナーのアカウント内の_すべての_ワークスペースで、カスタマーマネージャーに指定のロールを付与します。

サンプルリクエスト ​

shell
curl  -X POST 'https://www.workato.com/api/customer_managers' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "team_collaborator_id": 4321,
            "role_id": 2,
            "permitted_workspace_ids": [29456],
            "project_role_id": "pr-AQRtExgY-cEGWTN"
          }'

レスポンス ​

json
{
    "result": {
        "id": 1234,
        "user": {
            "id": 4321,
            "name": "Alex",
            "email": "[email protected]",
            "avatar_url": ""
        },
        "privilege_group": {
            "id": 2,
            "name": "Admin",
            "system": true
        },
        "moderated_workspaces": [
            {
                "id": 29456,
                "name": "ACME USA"
            }
        ],
        "project_role": {
            "id": "pr-AQRtExgY-cEGWTN",
            "name": "Builder"
        }
    }
}

カスタマーマネージャーを削除 ​

Embeddedパートナーのアカウントからカスタマーマネージャーを削除します。

shell
DELETE /api/customer_managers/:id

URLパラメーター ​

名前タイプ説明
idstring
必須		カスタマーマネージャーのID。

サンプルリクエスト ​

shell
curl  -X DELETE 'https://www.workato.com/api/customer_managers/1236' \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "result": "ok"
}

Last updated: