顧客の管理

Managed Usersリソースは、顧客をプログラムで管理する機能を提供します。

EMBEDDED API

このガイドのエンドポイントはEmbedded APIであり、Embeddedワークスペースが必要です。詳細については、Workato担当者にお問い合わせください。

APIクライアントアクセス

Embedded顧客ワークスペース内のコラボレーターを管理するには、APIクライアントにDEV Environmentへのアクセス権が必要です。 APIクライアントのアクセスを構成するには、クライアントロールを作成するを参照してください。

レート制限

顧客管理リソースには、次のレート制限があります:

タイプ	リソース	制限
POST	顧客を作成: /api/managed_users	1分あたり1,000リクエスト
DELETE	顧客ワークスペースからメンバーを削除: /api/managed_users/:id/members /:member_id	1分あたり1,000リクエスト
POST	Environmentをプロビジョニング: /api/managed_users/:id/environments	1分あたり1,000リクエスト
すべて	すべての利用状況エンドポイント	1分あたり1,000リクエスト
すべて	その他すべてのメンバーエンドポイント	1分あたり60リクエスト
すべて	その他すべての顧客管理エンドポイント	1分あたり60リクエスト

クイックリファレンス

非推奨のエンドポイント

次のエンドポイントは非推奨です:

/api/managed_users/:id/upgrade
/api/managed_users/:id/downgrade
/api/managed_users/:id/member

次の表に示す、完全にサポートされているエンドポイントを使用できます:

Managed Usersリソースには、次のエンドポイントが含まれています:

タイプ	リソース	説明
POST	/api/managed_users	顧客を作成します。
PUT	/api/managed_users/:id	顧客を更新します。
DELETE	/api/managed_users/:id	顧客を削除します。
GET	/api/managed_users/:id	顧客を取得します。
GET	/api/managed_users	すべての顧客を一覧表示します。
GET	/api/managed_users/:id/members	顧客ワークスペース内のコラボレーターのリストを取得します。
GET	/api/managed_users/:id/members/:member_id	顧客ワークスペースのコラボレーター詳細を取得します。
POST	/api/managed_users/:id/members	顧客ワークスペースにコラボレーターを追加します。
PUT	/api/managed_users/:id/members/:member_id	顧客ワークスペースのコラボレーターを更新します。
DELETE	/api/managed_users/:id/members/:member_id	顧客ワークスペースからコラボレーターを削除します。
GET	/api/managed_users/:id/members/:member_id/project_grants	顧客ワークスペースのコラボレーターのプロジェクト付与を一覧表示します。
GET	/api/managed_users/:id/connections	顧客ワークスペース内のコネクションを一覧表示します。
GET	/api/managed_users/:id/members/:member_id/privileges	顧客ワークスペースのコラボレーターから権限を取得します。
GET	/api/managed_users/:managed_user_id/members/ :id/projects_privileges	顧客ワークスペースのコラボレーターからプロジェクト権限を取得します。
POST	/api/v2/managed_users/statistics/usage	より詳細なデータ粒度で、顧客ワークスペースの利用状況メトリクスを取得します。
POST	/api/v2/managed_users/statistics/connection_usage	指定した顧客ワークスペースのコネクションベースの利用状況メトリクスを取得します。
GET	/api/managed_users/usage	すべての顧客のタスク利用状況を月別に取得します。
POST	/api/managed_users/:id/environments	既存の顧客にEnvironmentをプロビジョニングします。プロビジョニング後、顧客ワークスペース内の既存のアセットはDevelopment Environmentに配置されます。
POST	/api/v2/managed_users/:managed_user_id/environments	既存の顧客にEnvironment（v2）をプロビジョニングします。プロビジョニング後、顧客ワークスペース内の既存のアセットはプロダクション Environmentに配置されます。
GET	/api/v2/managed_users/environments_provision_tasks/:id	非同期Environmentプロビジョニングのステータスを取得します。
GET	/api/v2/managed_users/customer_categories	Embeddedパートナーのワークスペース内の顧客カテゴリを一覧表示します。
POST	/api/v2/managed_users/customer_categories	顧客カテゴリを作成します。
PUT	/api/v2/managed_users/customer_categories/:id	顧客カテゴリを更新します。
DELETE	/api/v2/managed_users/customer_categories/:id	顧客カテゴリを削除します。
POST	/api/v2/managed_users/customer_categories/:id/assign	顧客カテゴリをワークスペースに一括割り当てします。
POST	/api/v2/managed_users/customer_categories/:id/unassign	顧客カテゴリのワークスペースへの割り当てを一括解除します。
PUT	/api/managed_users/:id/upgrade このエンドポイントは非推奨です。代わりに、/api/managed_users/:idエンドポイントにPUTリクエストを実行し、顧客の`plan ID`を更新します。	非推奨。顧客をアップグレードします。
PUT	/api/managed_users/:id/downgrade このエンドポイントは非推奨です。代わりに、/api/managed_users/:idエンドポイントにPUTリクエストを実行し、顧客の`plan ID`を更新します。	非推奨。顧客をダウングレードします。
POST	/api/managed_users/:id/member このエンドポイントは非推奨です。代わりに、/api/managed_users/:id/membersエンドポイントにPOSTリクエストを実行します。	非推奨。顧客ワークスペースにメンバーを追加します。
DELETE	/api/managed_users/:id/member このエンドポイントは非推奨です。代わりに、/api/managed_users/:id/members/:member_idエンドポイントにDELETEリクエストを実行します。	非推奨。顧客ワークスペースからメンバーを削除します。

顧客の作成

新しいEmbedded顧客を作成します。

shell

POST /api/managed_users

リクエスト本文

名前	タイプ	説明
name	string 必須	顧客のフルネーム。
notification_email	string 必須	エラー通知と管理通知を受信するメールアドレス。
team_name	string 任意	顧客ワークスペースの名前。
oauth_id	string 任意	OAuth認証に使用する識別子。
provision_environments	boolean optional	新しいEmbedded顧客をEnvironments機能でプロビジョニングするかどうかを決定します。デフォルトは`false`です。
external_id	string 任意	Embedded顧客の外部識別子。
origin_url	string 任意	Embeddedアカウント顧客に適用されます。 Embedded iframeが顧客固有のカスタムドメインなど、デフォルト以外のオリジンページでホストされている場合は値を指定します。デフォルトでは、ワークスペースレベルで設定されたオリジンになります。
frame_ancestors	string 任意	Content-Security-Policy HTTPヘッダーのフレーム祖先として使用される、カンマ区切りURLのリスト。この設定により、指定したドメインでWorkato iframeをレンダリングできます。
plan_id	string 任意	プランID。指定しない場合、デフォルトは標準プランです。
custom_credit_limit	integer optional	顧客のプランで定義されているクレジット上限を上書きします。クレジット上限をプランの値にリセットするには、`0`を渡します。クレジットベースの上限を使用するプランの顧客にのみ適用されます。
time_zone	string 任意	タイムゾーン名。指定しない場合、デフォルトはPSTです。使用可能な値については、タイムゾーンリストを参照してください。
whitelisted_apps	array of strings optional	顧客がアクセスできるアプリのコネクション`provider`のリスト。詳細については、アプリアクセスセクションを参照してください。
full_embedding	boolean optional	trueの場合、エンドユーザーは顧客の`origin_url`に誘導されます。完全埋め込みを無効にするには、`false`に設定します。デフォルトは`null`で、Embeddedパートナーの管理設定から値（`true`または`false`）を継承します。
auth_settings	hash optional	顧客ワークスペースの認証設定。
auth_settings[type]	string conditional	認証タイプを指定します。指定できる値には、`workato_auth`、`two_fa_auth`、`saml_sso`があります。
auth_settings[provider]	string conditional	IDプロバイダー名。 `auth_settings[type]`として`saml_sso`を使用する場合は必須です。指定できる値には、`okta`、`onelogin`、`others`があります。
auth_settings[metadata_url]	string conditional	設定詳細用のIDプロバイダーのメタデータXMLファイルのURL。 `auth_settings[sso_url]`、`auth_settings[saml_issuer]`、`auth_settings[x509_cert]`が指定されていない場合は必須です。
auth_settings[sso_url]	string conditional	ユーザー認証用にIDプロバイダーから提供されるシングルサインオンURL。 `auth_settings[metadata_url]`が指定されていない場合は必須です。
auth_settings[saml_issuer]	string conditional	IDプロバイダーの一意の識別子で、多くの場合SAMLアサーションの発行者を識別するために使用されます。 `auth_settings[metadata_url]`が指定されていない場合は必須です。
auth_settings[x509_cert]	string conditional	IDプロバイダーからのX.509証明書。これはSAMLアサーション署名の検証に使用されます。 `auth_settings[metadata_url]`が指定されていない場合は必須です。
auth_settings[jit_provisioning]	boolean optional	Just-in-Time（JIT）プロビジョニングを有効にするかどうかを選択します。これにより、Workatoは初回サインイン時にユーザーアカウントを作成できます。
auth_settings[saml_role_updates_allowed]	boolean optional	SAML IDプロバイダーとのロール同期を有効にするかどうかを決定します。デフォルトは`true`です。
auth_settings[saml_required]	boolean optional	顧客にSAML認証を適用するかどうかを示します。デフォルトは`true`です。
environments	array of objects optional	各Environmentの外部IDやエラー通知メールなどの設定を指定するEnvironmentオブジェクトの配列。
environments [environment_type]	string 任意	顧客情報を作成するためのEnvironmentタイプを指定します。指定できる値には`dev`、`test`、`prod`がありますが、`dev`の含有に関する警告を参照してください。
environments [external_id]	string 任意	`test`または`prod` Environmentの外部ID。 `dev` Environmentには、メインリクエスト本文の`external_id`を使用します。
environments [error_notification_emails]	string 任意	`test`または`prod` Environmentのエラー通知メール。 `dev` Environmentには、メインリクエスト本文の`notification_email`を使用します。
timeout_id	string 任意	秒単位のタイムアウト。次の値を指定できます: - `900`（15分） - `1800`（30分） - `2700`（45分） - `14400`（4時間） - `28800`（8時間） - `43200`（12時間） - `86400`（1日） - `172800`（2日） - `259200`（3日） - `604800`（7日） - `1209600`（14日）

400 BAD REQUEST

dev Environmentにはenvironments[error_notification_emails]およびenvironments[external_id]を指定しないでください。

これらの値がメインリクエスト本文で指定されたnotification_emailおよびexternal_idと競合する場合、同じ属性に対する割り当てが競合するため、APIは400 Bad Requestエラーを返します。

代わりに、dev Environmentにはnotification_emailおよびexternal_idを使用し、testおよびprod Environmentにはenvironments[error_notification_emails]およびenvironments[external_id]を使用してください。

Workato認証を使用したリクエスト

このサンプルリクエストでは、Workato認証を使用して新しいEmbedded顧客を作成します。

shell

curl  -X POST https://www.workato.com/api/managed_users \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Alex Workato",
            "team_name": "Nutech",
            "notification_email": "[email protected]",
            "provision_environments": true,
            "external_id": "UU0239093497",
            "whitelisted_apps": ["salesforce", "netsuite"],
            "time_zone": "Central Time (US & Canada)",
            "auth_settings": {
                "type": "workato_auth"
            },
            "full_embedding": false,
            "environments": [
                {
                    "environment_type": "test",
                    "external_id": "UU0239093498",
                    "error_notification_emails": "[email protected]"
                },
                {
                    "environment_type": "prod",
                    "external_id": "UU0239093499",
                    "error_notification_emails": "[email protected]"
                }
            ]
          }'

レスポンス: Workato認証

json

{
    "id": 32122,
    "external_id": "UU0239093497",
    "name": "Alex Workato",
    "environments": [
        {
            "id": 32124,
            "environment_type": "prod",
            "external_id": "UU0239093499",
            "error_notification_emails": "[email protected]"
        },
        {
            "id": 32123,
            "environment_type": "test",
            "external_id": "UU0239093498",
            "error_notification_emails": "[email protected]"
        },
        {
            "id": 32122,
            "environment_type": "dev",
            "external_id": "UU0239093497",
            "error_notification_emails": "[email protected]"
        }
    ],
    "timeout_id":"43200",
    "notification_email": "[email protected]",
    "full_embedding": false,
    "admin_notification_emails": "[email protected]",
    "error_notification_emails": "[email protected]",
    "plan_id": "oem_enterprise",
    "origin_url": null,
    "trial": false,
    "in_trial": false,
    "whitelisted_apps": [
        "netsuite",
        "salesforce"
    ],
    "frame_ancestors": null,
    "created_at": "2024-12-11T11:04:37.084-08:00",
    "updated_at": "2024-12-11T11:04:37.084-08:00",
    "time_zone": "Central Time (US & Canada)",
    "team_name": "Nutech",
    "auth_settings": {
        "type": "workato_auth",
    },
    "current_billing_period_start": "2024-12-11T11:04:37.084-08:00",
    "current_billing_period_end": "2025-01-11T11:04:37.084-08:00",
    "task_count": 0,
    "active_connection_limit": 0,
    "active_connection_count": 0,
    "active_recipe_count": 0
}

SAML SSOとメタデータURLを使用したリクエスト

このサンプルリクエストでは、SAML SSOとメタデータURLを使用して新しいEmbedded顧客を作成します。この方法を使用する場合、次のauth_settingsフィールドが必要です:

type
provider
metadata_url

shell

curl  -X POST https://www.workato.com/api/managed_users \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Alex Workato",
            "team_name": "Nutech",
            "notification_email": "[email protected]",
            "provision_environments": true,
            "external_id": "UU0239093497",
            "whitelisted_apps": ["salesforce", "netsuite"],
            "time_zone": "Central Time (US & Canada)",
            "auth_settings": {
                "type": "saml_sso",
                "provider": "okta",
                "metadata_url: "https://nutech.okta.com/app/exk29ua5yiqFVszrz0h8/sso/saml/metadata",
                "saml_role_updates_allowed": true,
                "saml_required": true
            },
            "full_embedding": false,
            "environments": [
                {
                    "environment_type": "test",
                    "external_id": "UU0239093498",
                    "error_notification_emails": "[email protected]"
                },
                {
                    "environment_type": "prod",
                    "external_id": "UU0239093499",
                    "error_notification_emails": "[email protected]"
                }
            ]
          }'

レスポンス: SAML SSOとメタデータURL

json

{
    "id": 32122,
    "external_id": "UU0239093497",
    "name": "Alex Workato",
    "environments": [
        {
            "id": 32124,
            "environment_type": "prod",
            "external_id": "UU0239093499",
            "error_notification_emails": "[email protected]"
        },
        {
            "id": 32123,
            "environment_type": "test",
            "external_id": "UU0239093498",
            "error_notification_emails": "[email protected]"
        },
        {
            "id": 32122,
            "environment_type": "dev",
            "external_id": "UU0239093497",
            "error_notification_emails": "[email protected]"
        }
    ],
    "timeout_id":"43200",
    "notification_email": "[email protected]",
    "full_embedding": false,
    "admin_notification_emails": "[email protected]",
    "error_notification_emails": "[email protected]",
    "plan_id": "oem_enterprise",
    "origin_url": null,
    "trial": false,
    "in_trial": false,
    "whitelisted_apps": [
        "netsuite",
        "salesforce"
    ],
    "frame_ancestors": null,
    "created_at": "2024-12-11T11:04:37.084-08:00",
    "updated_at": "2024-12-11T11:04:37.084-08:00",
    "time_zone": "Central Time (US & Canada)",
    "team_name": "Nutech",
    "auth_settings": {
        "type": "saml_sso",
        "provider": "okta",
        "metadata_url": "https://nutech.okta.com/app/exk29ua5yiqFVszrz0h8/sso/saml/metadata",
        "saml_role_updates_allowed": true,
        "saml_required": true
    },
    "current_billing_period_start": "2024-12-11T11:04:37.084-08:00",
    "current_billing_period_end": "2025-01-11T11:04:37.084-08:00",
    "task_count": 0,
    "active_connection_limit": 0,
    "active_connection_count": 0,
    "active_recipe_count": 0
}

SAML SSOとX.509証明書を使用するリクエスト

このサンプルリクエストでは、SAML SSOとX.509証明書を使用して新しいEmbedded顧客を作成します。この方法を使用する場合、次のauth_settingsフィールドが必要です:

type
provider
sso_url
saml_issuer
x509_cert

shell

curl  -X POST https://www.workato.com/api/managed_users \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Alex Workato",
            "team_name": "Nutech",
            "notification_email": "[email protected]",
            "provision_environments": true,
            "external_id": "UU0239093497",
            "whitelisted_apps": ["salesforce", "netsuite"],
            "time_zone": "Central Time (US & Canada)",
            "auth_settings": {
                "type": "saml_sso",
                "provider": "okta",
                "sso_url": "https://nutech.okta.com/app/nutech_1/exk21ojjvq6212R6e5d7/sso/saml",
                "saml_issuer": "http://www.okta.com/exk21ojjvq6212R6e5d7",
                "x509_cert": "-----BEGIN CERTIFICATE-----\nMIID...YOUR_CERT_DATA...IDAQAB\n-----END CERTIFICATE-----"
            },
            "full_embedding": false,
            "environments": [
                {
                    "environment_type": "test",
                    "external_id": "UU0239093498",
                    "error_notification_emails": "[email protected]"
                },
                {
                    "environment_type": "prod",
                    "external_id": "UU0239093499",
                    "error_notification_emails": "[email protected]"
                }
            ]
          }'

レスポンス: SAML SSOとX.509証明書

json

{
    "id": 32122,
    "external_id": "UU0239093497",
    "name": "Alex Workato",
    "environments": [
        {
            "id": 32124,
            "environment_type": "prod",
            "external_id": "UU0239093499",
            "error_notification_emails": "[email protected]"
        },
        {
            "id": 32123,
            "environment_type": "test",
            "external_id": "UU0239093498",
            "error_notification_emails": "[email protected]"
        },
        {
            "id": 32122,
            "environment_type": "dev",
            "external_id": "UU0239093497",
            "error_notification_emails": "[email protected]"
        }
    ],
    "timeout_id":"43200",
    "notification_email": "[email protected]",
    "full_embedding": false,
    "admin_notification_emails": "[email protected]",
    "error_notification_emails": "[email protected]",
    "plan_id": "oem_enterprise",
    "origin_url": null,
    "trial": false,
    "in_trial": false,
    "whitelisted_apps": [
        "netsuite",
        "salesforce"
    ],
    "frame_ancestors": null,
    "created_at": "2024-12-11T11:04:37.084-08:00",
    "updated_at": "2024-12-11T11:04:37.084-08:00",
    "time_zone": "Central Time (US & Canada)",
    "team_name": "Nutech",
    "auth_settings": {
        "type": "saml_sso",
        "provider": "okta",
        "sso_url": "https://nutech.okta.com/app/nutech_1/exk21ojjvq6212R6e5d7/sso/saml",
        "saml_issuer": "http://www.okta.com/exk21ojjvq6212R6e5d7",
        "x509_cert": "-----BEGIN CERTIFICATE-----\nMIID...YOUR_CERT_DATA...IDAQAB\n-----END CERTIFICATE-----"
    },
    "current_billing_period_start": "2024-12-11T11:04:37.084-08:00",
    "current_billing_period_end": "2025-01-11T11:04:37.084-08:00",
    "task_count": 0,
    "active_connection_limit": 0,
    "active_connection_count": 0,
    "active_recipe_count": 0
}

顧客の更新

既存のEmbedded顧客の情報を更新します。このエンドポイントを使用して、テストEnvironmentとプロダクションEnvironmentの両方でexternal_idやerror_notification_emailsなどの特定のパラメーターを更新できます。 Environmentを指定するには、リクエスト本文にenvironmentsキーを含めます。

shell

PUT /api/managed_users/:id

補足事項:

タスクベースのプランの顧客の場合、このエンドポイントを使用してタスク制限の上書きを更新し、一度限りの調整を行います。
Embeddedパートナーの場合、このエンドポイントを使用して特定の顧客のカスタムオリジンURLを更新します。

パスパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客ID/外部ID。外部IDには`E`のプレフィックスを付ける必要があり（例: `EA2300`）、結果のIDはURLエンコードする必要があります。

リクエスト本文

プロパティ

プロパティは、ペイロードにそのプロパティが含まれている場合にのみ更新されます。プロパティの値をクリアするには、ペイロードでnullに設定します。

名前	タイプ	説明
name	string 任意	顧客ワークスペースの更新後の名前。顧客プロファイル、コラボレーター表示、および監査ログに表示されます。
team_name	string 任意	顧客に関連付けられているチームワークスペースの更新後の名前。ワークスペース設定、顧客管理ビュー、およびワークスペース間を切り替えるためのナビゲーションサイドバーに表示されます。
notification_email	string 任意	エラー通知と管理通知用のメール。
error_notification_emails	string 任意	エラー通知用のメールで、`notification_email`プロパティの値を上書きします。このプロパティは特に`dev` Environmentに適用され、`environments[error_notification_emails]`とは異なります。
admin_notification_emails	string 任意	管理通知用のメール。このプロパティは、通知メールプロパティに入力した内容を上書きします。
external_id	string 任意	Embedded顧客の外部識別子。このフィールドは特に`dev` Environmentに適用され、`environments[external_id]`とは異なります。
origin_url	string 任意	Embedded顧客に適用されます。埋め込み`iframe`がカスタムドメインまたはデフォルト以外のオリジンページでホストされている場合は値を指定します。デフォルトでは、アカウントレベルで設定されたオリジンになります。
frame_ancestors	string 任意	1つ以上のカンマ区切りのフレーム祖先を指定します。これらのURLは、Workato IFrameのレンダリングを許可するためにContent-Security-Policy HTTPヘッダーで使用されます。
plan_id	string 任意	プランのID。
in_trial	boolean optional	ユーザーを無料プランとサブスクリプションプランの間で切り替えます。
task_limit_adjustment	number optional	現在の会計期間のタスク制限を調整します。タスクベースのプランでのみ有効です。この調整は後続の期間には適用されません。負の調整を行うには`-`を追加します。例: `-5000`。
custom_task_limit	number optional	現在のプラン制限を上書きします。制限の上書きは、現在のタスク利用状況より大きい値にする必要があります。
custom_credit_limit	integer optional	顧客のプランで定義されているクレジット上限を上書きします。クレジット上限をプランの値にリセットするには、`0`を渡します。クレジットベースの上限を使用するプランの顧客にのみ適用されます。
whitelisted_apps	array optional	顧客がアクセスできるアプリを指定するコネクション`provider`値のリスト。詳細については、Admin Consoleアプリアクセスを参照してください。
time_zone	string 任意	タイムゾーン名。タイムゾーンのリストについては、このドキュメントを表示してください。指定しない場合、デフォルトはPSTです。
auth_settings	object optional	顧客の認証設定。指定できる`types`は`workato_auth`と`saml_sso`です。 `saml_sso`を設定する場合、指定できる`providers`には"okta"、"onelogin"、"others"があります。
auth_settings [saml_role_updates_allowed]	boolean optional	SAML IDプロバイダーとのロール同期を有効にするかどうかを決定します。デフォルトは`true`です。
auth_settings[saml_required]	boolean optional	SAML認証が適用されるかどうかを示します。デフォルトは`true`です。
current_billing_period_start	string 任意	現在の請求開始日を設定します。日付はISO 8601形式で指定する必要があります。
full_embedding	boolean optional	`true`に設定すると、エンドユーザーは顧客の`origin_url`に送信されます。顧客ワークスペースレベルで完全埋め込みリダイレクトプロセスを無効にするには、このフィールドを`false`に設定します。この値を指定しない場合、デフォルトは`null`になり、Embeddedパートナーの管理設定から値（`true`または`false`）を継承します。
environments	array of objects optional	各Environmentの外部IDやエラー通知メールなど、顧客情報を更新する場所を指定するEnvironmentオブジェクトの配列。
environments [environment_type]	string 必須	顧客情報を更新するためのEnvironmentタイプを指定します。指定できる値には`test`と`prod`があります。
environments [external_id]	string 任意	各Environment（`test`または`prod`）固有の更新後の外部ID。このフィールドはメインリクエスト本文の`external_id`とは異なり、指定したEnvironmentにのみ適用されます。
environments [error_notification_emails]	string 任意	各Environment（`test`または`prod`）の更新後のエラー通知メールを指定します。このフィールドはメインリクエスト本文の`error_notification_emails`とは異なり、指定したEnvironmentにのみ適用されます。
timeout_id	string 任意	秒単位のタイムアウト。次の値を指定できます: - `900`（15分） - `1800`（30分） - `2700`（45分） - `14400`（4時間） - `28800`（8時間） - `43200`（12時間） - `86400`（1日） - `172800`（2日） - `259200`（3日） - `604800`（7日） - `1209600`（14日）

サンプルリクエスト

shell

curl  -X PUT https://www.workato.com/api/managed_users/3498583 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Nutech",
            "team_name": "Nutech team workspace",
            "notification_email": "[email protected]",
            "admin_notification_emails": "[email protected]",
            "error_notification_emails": "[email protected]",
            "in_trial": false,
            "task_limit_adjustment": 1000,
            "custom_task_limit": 10000,
            "current_billing_period_start": "2024-11-01",
            "environments": [
                {
                    "environment_type": "test",
                    "external_id": "ext-ec-test-22",
                    "error_notification_emails": "[email protected]"
                },
                {
                    "environment_type": "prod",
                    "external_id": "ext-ec-prod-15",
                    "error_notification_emails": "[email protected]"
                }
            ],
            "external_id": "ext-ect-dev-13",
            "origin_url": "https://abc123.acme.com",
            "frame_ancestors": "https://mysite.test.com",
            "plan_id": "oem_enterprise",
            "time_zone": "Amsterdam",
            "whitelisted_apps": [
                "salesforce",
                "workday"
            ],
            "auth_settings": {
                "type": "saml_sso",
                "provider": "okta",
                "metadata_url": "https://nutech.okta.com/sso/metadata",
                "saml_role_updates_allowed": true,
                "saml_required": true
            },
            "full_embedding": true
        }'

レスポンス

json

{
    "id": 3498583,
    "external_id": "ext-ect-dev-13",
    "name": "Nutech",
    "environments": [
        {
            "id": 3498585,
            "environment_type": "prod",
            "external_id": "ext-ec-prod-15",
            "error_notification_emails": "[email protected]"
        },
        {
            "id": 3498584,
            "environment_type": "test",
            "external_id": "ext-ec-test-22",
            "error_notification_emails": "[email protected]"
        },
        {
            "id": 3498583,
            "environment_type": "dev",
            "external_id": "ext-ect-dev-13",
            "error_notification_emails": "[email protected]"
        }
    ],
    "timeout_id":"43200",
    "notification_email": "[email protected],[email protected]",
    "full_embedding": true,
    "admin_notification_emails": "[email protected]",
    "error_notification_emails": "[email protected]",
    "plan_id": "oem_enterprise",
    "origin_url": "https://abc123.acme.com",
    "trial": false,
    "in_trial": false,
    "whitelisted_apps": [
        "salesforce",
        "workday"
    ],
    "frame_ancestors": "https://mysite.test.com",
    "created_at": "2024-10-30T09:56:46.060-07:00",
    "updated_at": "2024-11-13T15:27:40.360-08:00",
    "time_zone": "Amsterdam",
    "team_name": "Nutech team workspace",
    "auth_settings": {
        "type": "workato_auth"
        "provider": "okta",
        "metadata_url": "https://nutech.okta.com/sso/metadata",
        "saml_role_updates_allowed": true,
        "saml_required": true
    },
    "current_billing_period_start": "2024-11-01T00:00:00.000-07:00",
    "current_billing_period_end": "2024-11-30T23:00:00.000-08:00",
    "task_count": 0,
    "active_connection_limit": 0,
    "active_connection_count": 3,
    "active_recipe_count": 0,
    "current_billing_period_start": "2024-11-01"
}

顧客の削除

Embedded顧客を削除します。

shell

DELETE /api/managed_users/:id

アカウントの復旧可能性

顧客アカウントを削除すると、完全に復旧することはできません。このエンドポイントを使用する際は注意してください。

パスパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客ID/外部ID。外部IDには`E`のプレフィックスを付ける必要があり（例: `EA2300`）、結果のIDはURLエンコードする必要があります。

サンプルリクエスト

shell

curl  -X DELETE https://www.workato.com/api/managed_users/28942 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

レスポンス

json

{
    "success": true
}

顧客の取得

Embedded顧客のアカウントに関する詳細を取得します。

shell

GET /api/managed_users/:id

パスパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客ID/外部ID。外部IDには`E`のプレフィックスを付ける必要があり（例: `EA2300`）、結果のIDはURLエンコードする必要があります。

サンプルリクエスト

shell

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

レスポンス

Environmentなし
Environmentあり

クレジット上限フィールド

credit_limitフィールドは、顧客のプランがクレジットベースの上限を使用している場合に、顧客のクレジット上限を返します。その他すべての顧客では、このフィールドはnullを返します。

Environmentなし

json

{
    "id": 27819,
    "external_id": null,
    "name": "ACME Automations",
    "environments": [],
    "notification_email": "[email protected]",
    "full_embedding": null,
    "admin_notification_emails": "[email protected]",
    "error_notification_emails": "[email protected]",
    "plan_id": "oem_enterprise",
    "origin_url": null,
    "trial": false,
    "in_trial": false,
    "whitelisted_apps": [],
    "frame_ancestors": null,
    "created_at": "2024-10-02T16:16:14.512-07:00",
    "updated_at": "2024-10-02T16:16:14.512-07:00",
    "time_zone": "Pacific Time (US & Canada)",
    "team_name": "ACME team workspace",
    "auth_settings": {
        "type": "workato_auth"
    },
    "current_billing_period_start": "2024-10-02T16:16:14.689-07:00",
    "current_billing_period_end": "2024-11-02T16:16:14.689-07:00",
    "credit_limit": null,
    "task_count": 0,
    "active_connection_limit": 0,
    "active_connection_count": 0,
    "active_recipe_count": 0
}

Environmentあり

json

{
    "id": 27819,
    "external_id": null,
    "name": "ACME Automations",
    "environments": [
        {
            "id": 27821,
            "environment_type": "prod",
            "external_id": null
        },
        {
            "id": 27820,
            "environment_type": "test",
            "external_id": null
        },
        {
            "id": 27819,
            "environment_type": "dev",
            "external_id": null
        }
    ],
    "notification_email": "[email protected]",
    "full_embedding": null,
    "admin_notification_emails": "[email protected]",
    "error_notification_emails": "[email protected]",
    "plan_id": "oem_enterprise",
    "origin_url": null,
    "trial": false,
    "in_trial": false,
    "whitelisted_apps": [],
    "frame_ancestors": null,
    "created_at": "2024-10-02T16:16:14.512-07:00",
    "updated_at": "2024-10-02T16:16:14.512-07:00",
    "time_zone": "Pacific Time (US & Canada)",
     "team_name": "ACME team workspace",
    "auth_settings": {
        "type": "workato_auth"
    },
    "current_billing_period_start": "2024-10-02T16:16:14.689-07:00",
    "current_billing_period_end": "2024-11-02T16:16:14.689-07:00",
    "credit_limit": null,
    "task_count": 0,
    "active_connection_limit": 0,
    "active_connection_count": 0,
    "active_recipe_count": 0
}

顧客のリストを取得

すべての顧客のリストを取得します。このエンドポイントは、Admin Consoleの顧客テーブル内のデータを返します。

shell

GET /api/managed_users/

クエリパラメーター

名前	タイプ	説明
page	number optional	ページ番号。デフォルトは1です。
per_page	number optional	ページサイズ。デフォルトは100（最大は100）です。
category_id	number optional	カテゴリIDで顧客をフィルタリングします。

サンプルリクエスト

shell

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

レスポンス

Environmentなし
Environmentあり

クレジット上限フィールド

レスポンス内のcredit_limitフィールドは、顧客のプランがクレジットベースの上限を使用している場合に、顧客のクレジット上限を返します。その他すべての顧客では、このフィールドはnullを返します。

請求期間のタスク数

このエンドポイントから提供されるタスク数は、顧客の請求期間中に完了したタスクの数を表します。

Environmentなし

json

{
    "result": [
        {
            "id": 27819,
            "external_id": null,
            "name": "ACME Automations",
            "environments": [],
            "notification_email": "[email protected]",
            "full_embedding": null,
            "admin_notification_emails": "[email protected]",
            "error_notification_emails": "[email protected]",
            "plan_id": "oem_enterprise",
            "origin_url": null,
            "trial": false,
            "in_trial": false,
            "whitelisted_apps": [],
            "frame_ancestors": null,
            "created_at": "2024-10-02T16:16:14.512-07:00",
            "updated_at": "2024-10-02T16:16:14.512-07:00",
            "time_zone": "Pacific Time (US & Canada)",
            "team_name": "ACME team workspace",
            "auth_settings": {
                "type": "workato_auth"
            },
            "current_billing_period_start": "2024-10-02T16:16:14.689-07:00",
            "current_billing_period_end": "2024-11-02T16:16:14.689-07:00",
            "credit_limit": null,
            "task_count": 0,
            "active_connection_limit": 0,
            "active_connection_count": 0,
            "active_recipe_count": 0
        },
        ...
    ]
}

Environmentあり

json

{
    "result": [
        {
            "id": 27819,
            "external_id": null,
            "name": "ACME Automations",
            "environments": [
                {
                    "id": 27821,
                    "environment_type": "prod",
                    "external_id": null
                },
                {
                    "id": 27820,
                    "environment_type": "test",
                    "external_id": null
                },
                {
                    "id": 27819,
                    "environment_type": "dev",
                    "external_id": null
                }
            ],
            "notification_email": "[email protected]",
            "full_embedding": null,
            "admin_notification_emails": "[email protected]",
            "error_notification_emails": "[email protected]",
            "plan_id": "oem_enterprise",
            "origin_url": null,
            "trial": false,
            "in_trial": false,
            "whitelisted_apps": [],
            "frame_ancestors": null,
            "created_at": "2024-10-02T16:16:14.512-07:00",
            "updated_at": "2024-10-02T16:16:14.512-07:00",
            "time_zone": "Pacific Time (US & Canada)",
            "team_name": "ACME team workspace",
            "auth_settings": {
                "type": "workato_auth"
            },
            "current_billing_period_start": "2024-10-02T16:16:14.689-07:00",
            "current_billing_period_end": "2024-11-02T16:16:14.689-07:00",
            "credit_limit": null,
            "task_count": 0,
            "active_connection_limit": 0,
            "active_connection_count": 0,
            "active_recipe_count": 0
        }
        ...
    ]
}

顧客ワークスペース内のコラボレーターのリストを取得

Embedded顧客ワークスペース内のすべてのコラボレーターのリストを取得します。

shell

GET /api/managed_users/:id/members

パスパラメーター

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

サンプルリクエスト

shell

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

レスポンス

json

[
  {
    "id": 1680,
    "grant_type": "team",
    "role_name": "Admin",
    "external_id": null,
    "name": "Rosario",
    "email": "[email protected]",
    "time_zone": "Pacific Time (US & Canada)",
    "user_groups": [
      {
        "id": "ug-APHDLfHB-dTXBtz",
        "name" : "All collaborators",
        "system": true
      },
      {
        "id": "ug-APHDLfHB-dTXBtg",
        "name" : "Developers",
        "system": false
      }
    ],
    "env_roles": [
      {
        "environment_type": "dev",
        "name": "Admin",
        "role_type": "privilege_group"
      }
    ]
  },
  {
    "id": 2641,
    "grant_type": "customer_manager",
    "role_name": "Admin",
    "external_id": null,
    "name": "Noam",
    "email": "[email protected]",
    "time_zone": "Eastern Time (US & Canada)",
    "user_groups": [
      {
        "id": "ug-APHDLfHB-dTXBtz",
        "name" : "All collaborators",
        "system": true
      }
    ],
    "env_roles": [
      {
        "environment_type": "dev",
        "name": "Admin",
        "role_type": "privilege_group"
      }
    ]
  }
]

顧客ワークスペースのコラボレーター詳細を取得

Embedded顧客ワークスペースからコラボレーターを取得します。

shell

GET /api/managed_users/:id/members/:member_id

パスパラメーター

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

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/managed_users/19029/members/34567' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "id": 1680,
  "grant_type": "team",
  "role_name": "Admin",
  "external_id": null,
  "name": "Noam",
  "email": "[email protected]",
  "time_zone": "Pacific Time (US & Canada)",
  "user_groups": [
    {
      "id": "ug-APHDLfHB-dTXBtz",
      "name" : "All collaborators",
      "system": true
    },
    {
      "id": "ug-APHDLfHB-dTXBtg",
      "name" : "Developers",
      "system": false
    }
  ],
  "env_roles": [
    {
      "environment_type": "dev",
      "name": "Admin",
      "role_type": "privilege_group"
    }
  ]
}

顧客ワークスペースにコラボレーターを追加

指定したEmbedded顧客ワークスペースにコラボレーターを追加します。または、管理対象顧客ワークスペースへのコラボレーターの招待エンドポイントを使用してコラボレーターを招待できます。

shell

POST /api/managed_users/:id/members

パスパラメーター

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

リクエスト本文

名前	タイプ	説明
role_name	string conditional	メンバーに割り当てるロール。 `env_roles`が指定されていない場合は必須です。
name	string conditional	メンバーのフルネーム。埋め込みワークスペースに追加する新しいユーザーを作成する場合は必須です。
env_roles	object conditional	Environmentロールオブジェクト。 `role_name`が指定されていない場合は必須です。
env_roles[environment_type]	string conditional	メンバーを追加する予定の顧客ワークスペース内のEnvironmentタイプ。 `role_name`が指定されていない場合は必須です。単一Environmentのワークスペースには`dev`を使用します。
env_roles[name]	string conditional	特定のEnvironmentでメンバーに割り当てるロール。 `role_name`が指定されていない場合は必須です。
env_roles[role_type]	string 任意	コラボレーターに割り当てるロールのタイプ。使用可能な値には、`privilege_group`と`environment`があります。デフォルト値は`privilege_group`です。
oauth_id	string 任意	OAuthに使用する識別子。
external_id	string 任意	メンバーの外部識別子。
time_zone	string 任意	タイムゾーン名。詳細については、タイムゾーンリストセクションを参照してください。指定しない場合、デフォルトはPSTです。
locale	string 任意	メンバーの言語設定のロケール（例: 英語の場合は`en`、ドイツ語の場合は`de`）。

異なるEnvironmentのロールを指定

リクエスト本文にはrole_nameまたはenv_rolesのいずれかを指定する必要があります:

role_nameはdev Environmentにのみロールを割り当てます。
env_rolesを使用すると、異なるEnvironmentのロールを指定できます。

同じリクエストでrole_nameとenv_rolesを組み合わせることはできません。両方が含まれている場合、Workatoはenv_roles内のロールのみを割り当て、role_nameを無視します。

既存ユーザーの追加

既存のWorkatoユーザーをEmbeddedワークスペースに追加するには、oauth_idを指定し、次のパラメーターを省略する必要があります:

role_name
external_id
time_zone
name
locale

サンプルリクエスト

特定のEnvironmentにコラボレーターを追加するには、次のセクションを参照してください:

role_nameを使用してdev Environmentを割り当てる
env_rolesを使用して特定のEnvironmentを割り当てる

role_nameの使用

shell

curl  -X POST https://www.workato.com/api/managed_users/27819/members \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Jack Smith",
            "role_name": "Admin",
            "external_id": "UU0239093499"
         }'

レスポンス: role_nameの使用

json

{
  "data": {
    "id": 12341,
    "grant_type": "team",
    "role_name": "Admin",
    "external_id": "UU0239093499",
    "name": "Jack Smith",
    "email": "[email protected]",
    "time_zone": "Pacific Time (US & Canada)",
    "created_at": "2024-09-13T07:26:48.779-07:00",
    "last_activity_log": null
  }
}

env_rolesの使用

shell

curl  -X POST https://www.workato.com/api/managed_users/27819/members \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Jack Smith",
            "env_roles": [
                {
                  "environment_type": "dev",
                  "name": "Admin",
                  "role_type": "privilege_group"
                },
                {
                  "environment_type": "test",
                  "name": "Admin",
                  "role_type": "privilege_group"

                },
                {
                  "environment_type": "prod",
                  "name": "Admin",
                  "role_type": "privilege_group"
                }
            ],
            "external_id": "UU0239093499"
         }'

レスポンス: env_rolesの使用

json

{
  "data": {
    "id": 12341,
    "grant_type": "team",
    "role_name": "Admin",
    "external_id": "UU0239093499",
    "name": "Jack Smith",
    "email": "[email protected]",
    "time_zone": "Pacific Time (US & Canada)",
    "created_at": "2024-09-24T08:06:09.883-07:00",
    "last_activity_log": null,
    "env_roles": [
      {
        "environment_type": "dev",
        "name": "Admin",
        "role_type": "privilege_group"
      },
      {
        "environment_type": "test",
        "name": "Admin",
        "role_type": "privilege_group"
      },
      {
        "environment_type": "prod",
        "name": "Admin",
        "role_type": "privilege_group"
      }
    ]
  }
}

顧客ワークスペースのコラボレーターを更新

Embedded顧客ワークスペース内の既存のコラボレーターとそのロールを更新します。

メンバー更新の制限

手動で追加されたかAPI経由で追加されたかにかかわらず、任意のメンバーのrole_nameフィールドを更新できます。

ただし、次のフィールドを更新できるのは、独自のWorkatoワークスペースを持たないコラボレーターに限られます:

oauth_id
external_id
time_zone
name
locale

これらのユーザーはEmbedded顧客ワークスペース内のコラボレーターとしてのみ存在し、スタンドアロンのWorkatoアカウントは所有していません。

shell

PUT /api/managed_users/:id/members/:member_id

パスパラメーター

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

リクエスト本文

名前	タイプ	説明
name	string 任意	メンバーの更新後のフルネーム。
role_name	string 任意	メンバーに割り当てる更新後のロール。同じリクエストに`role_name`と`env_roles`の両方を含めることはできません。
env_roles	object optional	コラボレーターの更新後のEnvironmentロールを定義します。同じリクエストに`env_roles`と`role_name`の両方を含めることはできません。
env_roles[environment_type]	string 任意	コラボレーターのロールを更新する予定のワークスペースEnvironmentのタイプ。単一Environmentのワークスペースには`dev`を使用します。
env_roles[name]	string 任意	特定のEnvironmentに対してコラボレーターに割り当てるロール。
env_roles[role_type]	string 任意	コラボレーターに割り当てるロールのタイプ。使用可能な値には、`privilege_group`と`environment`があります。デフォルト値は`privilege_group`です。
oauth_id	string 任意	OAuthに使用する更新後の識別子。
external_id	string 任意	メンバーの更新後の外部識別子。
time_zone	string 任意	更新後のタイムゾーン名。詳細については、タイムゾーンリストセクションを参照してください。指定しない場合、デフォルトはPSTです。
locale	string 任意	メンバーの言語設定の更新後のロケール（例: 英語の場合は`en`、ドイツ語の場合は`de`）。

異なるEnvironmentのロールを指定

role_nameはdev Environmentにのみロールを割り当てます。
env_rolesを使用すると、異なるEnvironmentのロールを指定できます。

サンプルリクエスト

特定のEnvironmentにコラボレーターを追加するには、次のセクションを参照してください:

role_nameを使用してdev Environmentを割り当てる
env_rolesを使用して特定のEnvironmentを割り当てる

role_nameの使用

shell

curl  -X PUT https://www.workato.com/api/managed_users/EUU0239093499/members/12341 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Jack Smith",
            "role_name": "Admin",
            "external_id": "UU0239093499"
         }'

レスポンス: role_nameの使用

json

{
  "data": {
    "id": 12341,
    "grant_type": "team",
    "role_name": "Admin",
    "external_id": "UU0239093499",
    "name": "Jack Smith",
    "email": "[email protected]",
    "time_zone": "Pacific Time (US & Canada)",
    "created_at": "2024-09-13T07:26:48.779-07:00",
    "last_activity_log": null
  }
}

env_rolesの使用

shell

curl  -X PUT https://www.workato.com/api/managed_users/EUU0239093499/members/12341 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Jack Smith",
            "env_roles": [
                {
                  "environment_type": "dev",
                  "name": "Admin",
                  "role_type": "privilege_group"
                },
                {
                  "environment_type": "test",
                  "name": "Admin",
                  "role_type": "privilege_group"

                },
                {
                  "environment_type": "prod",
                  "name": "Admin",
                  "role_type": "privilege_group"
                }
            ],
            "external_id": "UU0239093499"
         }'

レスポンス: env_rolesの使用

json

{
  "data": {
    "id": 12341,
    "grant_type": "team",
    "role_name": "Admin",
    "external_id": "UU0239093499",
    "name": "Jack Smith",
    "email": "[email protected]",
    "time_zone": "Pacific Time (US & Canada)",
    "created_at": "2024-09-24T08:06:09.883-07:00",
    "last_activity_log": null,
    "env_roles": [
      {
        "environment_type": "dev",
        "name": "Admin",
        "role_type": "privilege_group"
      },
      {
        "environment_type": "test",
        "name": "Admin",
        "role_type": "privilege_group"
      },
      {
        "environment_type": "prod",
        "name": "Admin",
        "role_type": "privilege_group"
      }
    ]
  }
}

顧客ワークスペースからコラボレーターを削除

Embedded顧客ワークスペースからコラボレーターを削除します。これにより、コラボレーターのWorkatoアカウントは削除されません。

shell

DELETE /api/managed_users/:id/members/:member_id

パスパラメーター

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

サンプルリクエスト

shell

curl -X DELETE 'https://www.workato.com/api/managed_users/19029/members/pg-AQAEnmMX-b4rPeT' \
  -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "data": [
    {
      "id": "pg-AQAEnmMX-b4rPeT"
    }
  ]
}

顧客ワークスペースのコラボレーターのプロジェクト付与を一覧表示

Embedded顧客ワークスペース内のコラボレーターに割り当てられたすべてのプロジェクト許可を取得します。これには、コラボレーターグループを通じて付与されたプロジェクトアクセスは含まれません。

プロジェクト付与

プロジェクト付与は、コラボレーターまたはグループにプロジェクトロールを割り当てます。 Embedded APIを使用してプロジェクト許可を管理するにはプロジェクト許可を、UIでプロジェクト許可を管理するにはプロジェクトアクセスとロールの管理を参照してください。

shell

GET /api/managed_users/:id/members/:member_id/project_grants

パスパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客IDまたは外部ID。外部IDはURLエンコードし、`E`のプレフィックスを付ける必要があります。例: `EA2300`。
member_id	string 必須	プロジェクト付与を取得するコラボレーターのID。

クエリパラメーター

名前	タイプ	説明
page[number]	integer optional	取得するページ番号。デフォルト値は`1`です。
page[size]	integer optional	取得するページあたりの項目数。デフォルト値および最大値は`100`です。

サンプルリクエスト

shell

curl -X GET 'https://www.workato.com/api/managed_users/19029/members/34567/project_grants?page[number]=1&page[size]=100' \
  -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "data": [
    {
      "id": "pg-AQAEnmMX-b4rPeT",
      "project": {
        "id": 178230,
        "name": "Development",
        "environment": {
          "id": 148425,
          "type": "dev"
        },
      },
      "project_role": {
        "id": "pr-AQAEnmK3-EQpeYM",
        "name": "Developers"
      }
    },
    {
      "id": "pg-AQAEnmKE-xpCFwT",
      "project": {
        "id": 178230,
        "name": "Sales",
        "environment": {
          "id": 148426,
          "type": "prod"
        },
      },
      "project_role": {
        "id": "pr-AQAEnmK3-EQpeYM",
        "name": "Developers"
      }
    }
  ],
  "total": 2,
  "page": {
    "number": 1,
    "size": 100
  }
}

顧客コネクションの一覧表示

Embedded顧客のアカウント内のコネクションのリストを取得します。

shell

GET /api/managed_users/:id/connections

パスパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客ID/外部ID。外部IDには`E`のプレフィックスを付ける必要があり（例: `EA2300`）、結果のIDはURLエンコードする必要があります。

サンプルリクエスト

shell

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

レスポンス

json

{
  "result": [
    {
      "id": 6132,
      "name": "My Box account",
      "provider": "box",
      "authorization_status": "success",
      "authorized_at": "2019-09-10T18:20:08.854-07:00",
      "created_at": "2019-09-10T18:19:57.437-07:00",
      "updated_at": "2019-09-10T18:20:08.859-07:00"
    },
    {
      "id": 6131,
      "name": "My Salesforce account",
      "provider": "salesforce",
      "authorization_status": "success",
      "authorized_at": "2019-09-10T18:19:43.018-07:00",
      "created_at": "2019-09-10T18:19:12.902-07:00",
      "updated_at": "2019-09-10T18:19:43.021-07:00"
    }
  ]
}

顧客ワークスペースのコラボレーターから権限を取得

Embedded顧客ワークスペース内のコラボレーターの権限とロールを取得します。レスポンスは、各Environment（例: dev、test、prod）のロールの配列を次の情報とともに返します:

Environmentタイプ
ユーザーロール
ロールに割り当てられたすべての権限
ロールタイプ

レスポンスには、従来のモデル（role_type: privilege_group）と新しいモデル（role_type: environment）の両方のロールが含まれます。

shell

GET /api/managed_users/:id/members/:member_id/privileges

パスパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客IDまたは外部ID。外部IDはURLエンコードし、`E`のプレフィックスを付ける必要があります。例: `EA2300`。
member_id	string 必須	権限を取得する予定のコラボレーターのID。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/managed_users/19029/members/34567/privileges' \
      -H 'Authorization: Bearer <api_token>'

サンプルレスポンス

json

{
    "data": [
        {
            "environment_type": "dev",
            "name": "Operator",
            "role_type": "privilege_group",
            "privileges": {
                "Recipes": [
                    "read",
                    "run",
                    "read_run_history"
                ],
                "Folders": [
                    "read"
                ],
                "Projects": [
                    "read"
                ],
                "Use in recipes": [
                    "all"
                ],
                "Test automation": [
                    "read"
                ]
            }
        },
        {
            "environment_type": "test",
            "name": "Operator",
            "role_type": "privilege_group",
            "privileges": {
                "Recipes": [
                    "read",
                    "run",
                    "read_run_history"
                ],
                "Folders": [
                    "read"
                ],
                "Projects": [
                    "read"
                ],
                "Use in recipes": [
                    "all"
                ],
                "Test automation": [
                    "read"
                ]
            }
        },
        {
            "environment_type": "prod",
            "name": "Operator",
            "role_type": "privilege_group",
            "privileges": {
                "Recipes": [
                    "read",
                    "run",
                    "read_run_history"
                ],
                "Folders": [
                    "read"
                ],
                "Projects": [
                    "read"
                ],
                "Use in recipes": [
                    "all"
                ],
                "Test automation": [
                    "read"
                ]
            }
        }
    ]
}

顧客ワークスペースのコラボレーターからプロジェクト権限を取得

Embedded顧客ワークスペース内のコラボレーターのプロジェクトレベルのアクセス権を取得します。これには、直接割り当てられたアクセス、またはコラボレーターグループのメンバーシップを通じて割り当てられたアクセスが含まれます。このエンドポイントを使用して、プロジェクト権限を監査できます。

shell

GET /api/managed_users/:id/members/:member_id/projects_privileges

パスパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客IDまたは外部ID。外部IDはURLエンコードし、`E`のプレフィックスを付ける必要があります。例: `EA2300`。
member_id	string 必須	プロジェクト権限の取得元となるコラボレーターのID。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/managed_users/19029/members/34567/projects_privileges' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "data": [
    {
      "environment": {
        "id": 123456,
        "type": "dev"
      },
      "projects": {
        "61722": {
          "Folders": ["create", "view"]
        }
      }
    },
    {
      "environment": {
        "id": 789123,
        "type": "prod"
      },
      "projects": {
        "74137": {
          "Folders": ["view"]
        }
      }
    }
  ]
}

利用状況の取得（v2）

指定された時間枠内の指定された顧客ワークスペースの利用状況メトリクスを取得します。これには、タスク利用状況、レシピ数、成功および失敗したジョブ数が含まれます。このエンドポイントは、Embedded管理者のワークスペースのタイムゾーンでdatetime値を解析して返します。

shell

POST /api/v2/managed_users/statistics/usage

複数のワークスペースの利用状況を1つのリクエストでクエリ

パフォーマンスを最適化するため、関連するすべてのワークスペースの利用状況を1つのリクエストでクエリすることをお勧めします。

ジョブのカウントと割り当て

一意の各ジョブ実行は1回だけカウントされます。ジョブが二重にカウントされることはありませんが、クエリの時間枠、間隔、および最新の再試行に応じて、異なる方法で割り当てられる場合があります。

リクエスト本文

名前	タイプ	説明
from	string 必須	利用状況メトリクスを取得する日付範囲の開始日。ISO 8601形式（`YYYY-MM-DD`）。
to	string 必須	利用状況メトリクスを取得する日付範囲の終了日。ISO 8601形式（`YYYY-MM-DD`）。
interval	string 任意	結果を集計する時間間隔を設定します。指定できる値には、`none`、`year`、`month`、`week`、`day`、`hour`があります。デフォルトは`none`です。
workspace_ids[]	整数の配列条件付き	利用状況データを取得する顧客ワークスペースID。 `external_ids[]`が指定されていない場合は必須です。
external_ids[]	array of strings conditional	利用状況データを取得する顧客外部ID。 `workspace_ids[]`が指定されていない場合は必須です。
folder_ids[]	array of integers optional	結果を指定されたフォルダIDにフィルタリングし、それらのフォルダ内のタスクとジョブ結果を返します。 `folder_name_pattern`を使用する場合は指定しないでください。
folder_name_pattern	string 任意	指定された名前パターンに一致するフォルダで結果をフィルタリングします（例: `[PROD] Folder`）。大文字と小文字が区別されます。 `folder_ids[]`を使用する場合は指定しないでください。ワイルドカードと正規表現はサポートされていません。
recipe_ids[]	array of integers optional	結果を指定されたレシピIDにフィルタリングし、それらのレシピに関連するタスクとジョブ結果を返します。 `recipe_name_pattern`を使用する場合は指定しないでください。
recipe_name_pattern	string 任意	指定された名前パターンに一致するレシピで結果をフィルタリングします（例: `[TEST] Recipe`）。大文字と小文字が区別されます。 `recipe_ids[]`を使用する場合は指定しないでください。ワイルドカードと正規表現はサポートされていません。
adapter_names_all[]	array of strings optional	指定されたすべてのコネクターを使用するレシピに結果をフィルタリングします（例: `["stripe", "workday", "zendesk"]`）。 `adapter_names_any[]`を使用する場合は指定しないでください。
adapter_names_any[]	array of strings optional	指定されたコネクターのいずれかを使用するレシピに結果をフィルタリングします（例: `["stripe", "workday", "zendesk"]`）。 `adapter_names_all[]`を使用する場合は指定しないでください。
running	boolean optional	結果をアクティブ（`true`）または非アクティブ（`false`）のレシピにフィルタリングします。デフォルトは`nil`で、アクティブと非アクティブの両方のレシピが含まれます。
group_by	string 任意	結果をどのようにグループ化するかを指定します。指定できる値には`recipe`と`workspace`があります。デフォルトは`workspace`です。 `folder_ids[]`、`recipe_ids[]`、`folder_name_pattern`、または`recipe_name_pattern`のいずれかが指定されている場合にのみ、`recipe`に設定できます。

削除済みレシピの利用状況メトリクスを含める

レスポンスに削除済みレシピのメトリクスを含めるには、リクエスト本文に次のフィールドのみを指定します:

from
to
workspace_idsまたはexternal_ids
interval（任意）

追加フィールドを含めると、利用状況データは、それらの条件に一致する未削除のレシピに制限されます。

大文字と小文字を区別するフィルター

recipe_name_patternおよびfolder_name_patternフィルターでは大文字と小文字が区別されます。これらのフィルターは、名前に指定されたパターンを含むレシピまたはフォルダを返します。たとえば、DeVelopmentとMedveDeVの両方がパターンDeVに一致します。フィルターでは、3文字以上のパターンを指定できます。

サンプルリクエスト

このサンプルリクエストでは、IDが10および2の顧客ワークスペースについて、2024年7月1日から2024年9月26日までの月次利用状況統計を取得します。レスポンスは指定されたレシピ（ID 100および200）でグループ化されます。

shell

curl  -X POST 'https://www.workato.com/api/v2/managed_users/statistics/usage' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "group_by": "recipe",
            "interval": "month",
            "workspace_ids": [10, 2],
            "recipe_ids": [100, 200],
            "from": "2024-07-01",
            "to": "2024-09-26"
          }'

レスポンス

200 OK

json

{
    "data": [
        {
            "recipe_id": 100, // Only part of the response when grouped by 'recipe'
            "workspace_id": 10,
            "intervals": [
                {
                    "start_datetime": "2024-07-01T00:00:00.000-07:00",
                    "successful_job_count": 52,
                    "failed_job_count": 3,
                    "task_count": 110
                },
                {
                    "start_datetime": "2024-08-01T00:00:00.000-07:00",
                    "successful_job_count": 78,
                    "failed_job_count": 6,
                    "task_count": 150
                },
                {
                    "start_datetime": "2024-09-01T00:00:00.000-07:00",
                    "successful_job_count": 64,
                    "failed_job_count": 2,
                    "task_count": 130
                }
            ]
        },
        {
            "recipe_id": 200,
            "workspace_id": 2,
            "intervals": [
                {
                    "start_datetime": "2024-07-01T00:00:00.000-07:00",
                    "successful_job_count": 43,
                    "failed_job_count": 5,
                    "task_count": 95
                },
                {
                    "start_datetime": "2024-08-01T00:00:00.000-07:00",
                    "successful_job_count": 61,
                    "failed_job_count": 8,
                    "task_count": 125
                },
                {
                    "start_datetime": "2024-09-01T00:00:00.000-07:00",
                    "successful_job_count": 72,
                    "failed_job_count": 7,
                    "task_count": 140
                }
            ]
        }
    ],
    "generated_at": "2024-09-26T13:48:46.839-07:00"
}

400 BAD REQUEST - 一致するワークスペースが見つかりません

リクエストで指定されたワークスペースIDまたは外部IDがEmbeddedアカウントの顧客リストに属していない場合、または一致しないすべてのワークスペースIDが無視されて結果のリストが空になった場合、次のエラーが返されます:

json

{
    "errors": [
        {
            "code": 400,
            "title": "No workspaces found matching the specified workspace filter conditions."
        }
    ]
}

400 BAD REQUEST - 一致するレシピが見つかりません

リクエストで指定されたフォルダIDまたはレシピIDが指定されたワークスペースまたはフォルダに属していない場合、または無効なフォルダID、レシピID、フォルダ名パターン、レシピ名パターンがすべて無視されて結果のリストが空になった場合、次のエラーが返されます:

json

{
    "errors": [
        {
            "code": 400,
            "title": "No recipes found matching the specified filter conditions."
        }
    ]
}

400 BAD REQUEST - 指定されたアダプターが見つかりません

リクエストに存在しないアダプターがadapter_names_anyまたはadapter_names_allに含まれている場合、次のエラーが返されます:

json

{
    "errors": [
        {
            "code": 400,
            "title": "Specified adapters in the filter condition not found."
        }
    ]
}

コネクションベースの利用状況の取得

指定した顧客ワークスペースのコネクションベースの利用状況メトリクスを取得します。このエンドポイントは、利用状況の取得（v2）エンドポイントを通じて利用できるタスクベースのメトリクスとは異なる、コネクション固有の利用状況メトリクスを提供します。

shell

POST /api/v2/managed_users/statistics/connection_usage

リクエスト本文

名前	タイプ	説明
workspace_ids[]	整数の配列条件付き	コネクションベースの利用状況データを取得するために使用する顧客ワークスペースID。 `external_ids[]`が指定されていない場合は必須です。
external_ids[]	array of strings conditional	コネクションベースの利用状況データを取得するために使用する顧客外部ID。 `workspace_ids[]`が指定されていない場合は必須です。
folder_ids[]	array of integers optional	指定したフォルダIDで結果をフィルタリングし、それらのフォルダ内のタスクとジョブ結果を返します。 `folder_name_pattern`を使用する場合は指定しないでください。
folder_name_pattern	string 任意	指定された名前パターンに一致するフォルダで結果をフィルタリングします（例: `[PROD] Folder`）。大文字と小文字が区別されます。 `folder_ids[]`を使用する場合は指定しないでください。ワイルドカードと正規表現はサポートされていません。
adapter_names[]	array of strings optional	指定したコネクターで結果をフィルタリングします。
include_runtime_connections	boolean optional	レスポンスにランタイムコネクションデータを含めるかどうかを指定します。デフォルトは`false`です。

サンプルリクエスト

shell

curl  -X POST 'https://www.workato.com/api/v2/managed_users/statistics/connection_usage' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "workspace_ids": [4552523],
            "folder_ids": [21256536],
            "adapter_names": ["salesforce", "workday", "stripe"]
          }'

レスポンス

json

{
    "data": [
        {
            "active_connections_count": 3,
            "active_connections_data": [
                {
                    "id": 15728497,
                    "name": "My Salesforce account",
                    "provider": "salesforce",
                    "authorization_status": "success",
                    "recipe_count": 5,
                    "running_recipe_count": 2,
                    "external_id": null,
                    "folder_id": 21256536,
                    "parent_account_id": null
                },
                {
                    "id": 15816920,
                    "name": "My Workday account",
                    "provider": "workday",
                    "authorization_status": "success",
                    "recipe_count": 2,
                    "running_recipe_count": 2,
                    "external_id": null,
                    "folder_id": 21256536,
                    "parent_account_id": null
                },
                {
                    "id": 15816922,
                    "name": "My Stripe account",
                    "provider": "stripe",
                    "authorization_status": "success",
                    "recipe_count": 2,
                    "running_recipe_count": 2,
                    "external_id": null,
                    "folder_id": 21256536,
                    "parent_account_id": null
                }
            ],
            "inactive_connections_count": 0,
            "inactive_connections_data": [],
            "active_opa_count": 0,
            "workspace_id": 4552523
        }
    ],
    "generated_at": "2024-10-23T08:53:05.428-07:00"
}

月次利用状況の取得

過去12か月のすべてのEmbedded顧客の月次利用状況メトリクスを取得します。このエンドポイントは、Embedded管理者のワークスペースタイムゾーンでdatetime値を返します。現在、このエンドポイントではタスクデータのみ利用できます。

shell

GET /api/managed_users/usage

GET利用状況V2 API

特定の日付範囲、ワークスペース、プロジェクト、またはレシピについて、より詳細なタスク情報を取得するには、利用状況の取得（v2）エンドポイントを使用します。

カレンダー月別タスク数

このエンドポイントによって返される顧客別のタスク数は、関連付けられたカレンダー月に実行されたすべてのタスクの合計です。顧客のプランが変更された場合や請求日/利用状況がリセットされた場合でも、このエンドポイントを使用してすべてのプランの合計利用状況を取得できます。

サンプルリクエスト

shell

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

レスポンス

注: 次のレスポンスは12か月から3か月に短縮されています。

json

{
   "result":{
      "data":[
         {
            "user_id": 7443,
            "intervals":[
               {
                  "start_datetime": "2019-10-01T00:00:00.000-07:00",
                  "task_count": null
               },
               {
                  "start_datetime": "2019-11-01T00:00:00.000-07:00",
                  "task_count": null
               },
               {
                  "start_datetime": "2020-10-01T00:00:00.000-07:00",
                  "task_count": 0
               }
            ]
         }
      ],
      "generated_at":"2020-10-02T05:41:29.232-07:00"
   }
}

Environmentのプロビジョニング

既存の顧客にEnvironmentをプロビジョニングします。プロビジョニング後、顧客ワークスペース内の既存のアセットはDevelopment Environmentに配置されます。

shell

POST /api/managed_users/:id/environments

URLパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客ID/外部ID。外部IDには`E`をプレフィックスとして付ける必要があり（例: `EA2300`）、生成されるIDはURLエンコードする必要があります。

リクエスト本文

名前	タイプ	説明
environments	array optional	Environment設定のリスト。
environment_type	string conditional	Environmentのタイプを指定します。 `environments`が存在する場合は必須です。指定可能な値には`dev`、`test`、`prod`があります。
external_id	string 任意	Environmentの一意の識別子。
error_notification_emails	string 任意	エラー通知を受信するメールアドレス。

サンプルリクエスト

shell

curl -X POST https://www.workato.com/api/managed_users/:id/environments \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "environments": [
             {
               "environment_type": "dev",
               "external_id": "C1Dev",
               "error_notification_emails": "[email protected]"
             },
             {
               "environment_type": "test",
               "external_id": "C1Test",
               "error_notification_emails": "[email protected]"
             },
             {
               "environment_type": "prod",
               "external_id": "C1Prod",
               "error_notification_emails": "[email protected]"
             }
           ]
         }'

サンプルレスポンス

json

{
    "data": {
        "status": "created",
        "id": 29069,
        "external_id": null,
        "name": "Barnaby",
        "environments": [
            {
                "id": 29541,
                "environment_type": "prod"
            },
            {
                "id": 29540,
                "environment_type": "test"
            }
        ],
        "notification_email": "[email protected]",
        "full_embedding": true,
        "admin_notification_emails": "[email protected] ",
        "error_notification_emails": "[email protected]",
        "plan_id": "premium_quarterly",
        "origin_url": null,
        "trial": false,
        "in_trial": false,
        "whitelisted_apps": [],
        "frame_ancestors": null,
        "created_at": "2023-11-13T23:59:29.420-09:00",
        "updated_at": "2024-02-29T06:02:58.078-09:00",
        "time_zone": "Pacific Time (US & Canada)",
        "auth_settings": {
            "type": "workato_auth"
        },
        "current_billing_period_start": "2024-03-08T08:19:19.079-09:00",
        "current_billing_period_end": "2024-04-08T09:19:19.079-08:00",
        "task_count": 0,
        "active_connection_limit": 0,
        "active_connection_count": 5,
        "active_recipe_count": 5
    }
}

Environmentのプロビジョニング（v2）

既存の顧客にEnvironmentをプロビジョニングします。このエンドポイントはタスクIDを返し、プロビジョニングは非同期で完了します。プロビジョニング後、顧客ワークスペース内の既存のアセットはプロダクション Environmentに配置されます。返されたtask_idをEnvironmentプロビジョニングのステータス取得エンドポイントで使用して、進行状況を追跡します。

shell

POST /api/v2/managed_users/:managed_user_id/environments

URLパラメーター

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。外部IDには`E`をプレフィックスとして付ける必要があり（例: `EA2300`）、生成されるIDはURLエンコードする必要があります。

サンプルリクエスト

shell

curl -X POST https://www.workato.com/api/v2/managed_users/:managed_user_id/environments \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json'

サンプルレスポンス

json

{
    "data": {
        "task_id": 1392
    }
}

Environmentプロビジョニングのステータス取得

非同期Environmentプロビジョニングのステータスを取得します。

shell

GET /api/v2/managed_users/environments_provision_tasks/:id

URLパラメーター

名前	タイプ	説明
id	integer required	EnvironmentプロビジョニングタスクのID。

サンプルリクエスト

shell

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

サンプルレスポンス

json

{
    "data": {
        "id": 1392,
        "status": "completed",
        "source_workspace_id": 5952556,
        "target_workspace_id": 7645656,
        "name": "WFA Test"
    }
}

顧客カテゴリーのリスト取得

Embeddedパートナーのワークスペース内の顧客カテゴリーのリストを取得します。

text

GET /api/v2/managed_users/customer_categories

クエリパラメーター

名前	タイプ	説明
page	integer optional	取得する顧客カテゴリーのページ番号。デフォルトは1です。
per_page	integer optional	1ページで返す顧客カテゴリーの数。デフォルトは100です。最大値は100です。

サンプルリクエスト

shell

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

レスポンス

json

{
  "data": [
    {
      "id": 12345,
      "name": "Enterprise"
    },
    {
      "id": 12346,
      "name": "SMB"
    }
  ]
}

顧客カテゴリーの作成

Embeddedパートナーのワークスペース内に新しい顧客カテゴリーを作成します。

text

POST /api/v2/managed_users/customer_categories

ペイロード

名前	タイプ	説明
customer_category	hash required	顧客カテゴリーオブジェクト。
customer_category[name]	string 必須	顧客カテゴリーの名前。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/v2/managed_users/customer_categories \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "customer_category": {
                "name": "retail"
            }
          }'

レスポンス

json

{
  "data": {
    "id": 12347,
    "name": "retail"
  }
}

顧客カテゴリーの更新

Embeddedパートナーのワークスペース内の顧客カテゴリーを更新します。

text

PUT /api/v2/managed_users/customer_categories/:id

URLパラメーター

名前	タイプ	説明
id	integer required	顧客カテゴリーのID。

ペイロード

名前	タイプ	説明
customer_category	hash required	顧客カテゴリーオブジェクト。
customer_category[name]	string 必須	顧客カテゴリーの名前。

サンプルリクエスト

shell

curl  -X PUT https://www.workato.com/api/v2/managed_users/customer_categories/12347 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "customer_category": {
                "name": "Retail"
            }
          }'

レスポンス

json

{
  "data": {
    "id": 12347,
    "name": "Retail"
  }
}

顧客カテゴリーの削除

Embeddedパートナーのワークスペース内の顧客カテゴリーを削除します。

text

DELETE /api/v2/managed_users/customer_categories/:id

URLパラメーター

名前	タイプ	説明
id	integer required	顧客カテゴリーのID。

サンプルリクエスト

shell

curl  -X DELETE https://www.workato.com/api/v2/managed_users/customer_categories/12347 \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "data": {
    "success": true
  }
}

顧客カテゴリーのワークスペースへの一括割り当て

顧客カテゴリーをEmbedded顧客ワークスペースに割り当てます。

text

POST /api/v2/managed_users/customer_categories/:id/assign

URLパラメーター

名前	タイプ	説明
id	integer required	顧客カテゴリーのID。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/v2/managed_users/customer_categories/12347/assign \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'

レスポンス

json

{
  "data": {
    "id": 12347,
    "name": "retail"
  }
}

顧客カテゴリーのワークスペースからの一括割り当て解除

顧客カテゴリーをEmbedded顧客ワークスペースから割り当て解除します。

text

POST /api/v2/managed_users/customer_categories/:id/unassign

URLパラメーター

名前	タイプ	説明
id	integer required	顧客カテゴリーのID。

ペイロード

名前	タイプ	説明
customer_category	hash required	顧客カテゴリーオブジェクト。
customer_category[user_ids]	array of integers optional	この顧客カテゴリーから削除するワークスペースID。最大値は100です。
customer_category[external_ids]	array of strings optional	この顧客カテゴリーから削除する外部ワークスペースID。最大値は100です。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/v2/managed_users/customer_categories/12347/unassign \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "customer_category": {
              "user_ids": [1001, 1002, 1003],
              "external_ids": ["ext_001", "ext_002"]
            }
          }'

レスポンス

json

{
  "data": {
    "id": 12347,
    "name": "retail"
  }
}

Last updated:

顧客の管理 ​

レート制限 ​

クイックリファレンス ​

顧客の作成 ​

リクエスト本文 ​

サンプルリクエスト ​

Workato認証を使用したリクエスト ​

SAML SSOとメタデータURLを使用したリクエスト ​

SAML SSOとX.509証明書を使用するリクエスト ​

顧客の更新 ​

パスパラメーター ​

リクエスト本文 ​

サンプルリクエスト ​

レスポンス ​

顧客の削除 ​

パスパラメーター ​

サンプルリクエスト ​

レスポンス ​

顧客の取得 ​

パスパラメーター ​

サンプルリクエスト ​

レスポンス ​

Environmentなし ​

Environmentあり ​

顧客のリストを取得 ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

Environmentなし ​

Environmentあり ​

顧客ワークスペース内のコラボレーターのリストを取得 ​

パスパラメーター ​

サンプルリクエスト ​

レスポンス ​

顧客ワークスペースのコラボレーター詳細を取得 ​

パスパラメーター ​

サンプルリクエスト ​

レスポンス ​

顧客ワークスペースにコラボレーターを追加 ​

パスパラメーター ​

リクエスト本文 ​

サンプルリクエスト ​

role_nameの使用 ​

env_rolesの使用 ​

顧客ワークスペースのコラボレーターを更新 ​

パスパラメーター ​

リクエスト本文 ​

サンプルリクエスト ​

role_nameの使用 ​

env_rolesの使用 ​

顧客ワークスペースからコラボレーターを削除 ​

パスパラメーター ​

サンプルリクエスト ​

レスポンス ​

顧客ワークスペースのコラボレーターのプロジェクト付与を一覧表示 ​

パスパラメーター ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

顧客コネクションの一覧表示 ​

パスパラメーター ​

サンプルリクエスト ​

レスポンス ​

顧客ワークスペースのコラボレーターから権限を取得 ​

パスパラメーター ​

サンプルリクエスト ​

サンプルレスポンス ​

顧客ワークスペースのコラボレーターからプロジェクト権限を取得 ​

パスパラメーター ​

サンプルリクエスト ​

レスポンス ​

利用状況の取得（v2） ​

リクエスト本文 ​

サンプルリクエスト ​

レスポンス ​

コネクションベースの利用状況の取得 ​

リクエスト本文 ​

サンプルリクエスト ​

レスポンス ​

月次利用状況の取得 ​

顧客の管理

レート制限

クイックリファレンス

顧客の作成

リクエスト本文

サンプルリクエスト

Workato認証を使用したリクエスト

SAML SSOとメタデータURLを使用したリクエスト

SAML SSOとX.509証明書を使用するリクエスト

顧客の更新

パスパラメーター

リクエスト本文

サンプルリクエスト

レスポンス

顧客の削除

パスパラメーター

サンプルリクエスト

レスポンス

顧客の取得

パスパラメーター

サンプルリクエスト

レスポンス

Environmentなし

Environmentあり

顧客のリストを取得

クエリパラメーター

サンプルリクエスト

レスポンス

Environmentなし

Environmentあり

顧客ワークスペース内のコラボレーターのリストを取得

パスパラメーター

サンプルリクエスト

レスポンス

顧客ワークスペースのコラボレーター詳細を取得

パスパラメーター

サンプルリクエスト

レスポンス

顧客ワークスペースにコラボレーターを追加

パスパラメーター

リクエスト本文

サンプルリクエスト

role_nameの使用

env_rolesの使用

顧客ワークスペースのコラボレーターを更新

パスパラメーター

リクエスト本文

サンプルリクエスト

role_nameの使用

env_rolesの使用

顧客ワークスペースからコラボレーターを削除

パスパラメーター

サンプルリクエスト

レスポンス

顧客ワークスペースのコラボレーターのプロジェクト付与を一覧表示

パスパラメーター

クエリパラメーター

サンプルリクエスト

レスポンス

顧客コネクションの一覧表示

パスパラメーター

サンプルリクエスト

レスポンス

顧客ワークスペースのコラボレーターから権限を取得

パスパラメーター

サンプルリクエスト

サンプルレスポンス

顧客ワークスペースのコラボレーターからプロジェクト権限を取得

パスパラメーター

サンプルリクエスト

レスポンス

利用状況の取得（v2）

リクエスト本文

サンプルリクエスト

レスポンス

コネクションベースの利用状況の取得

リクエスト本文

サンプルリクエスト

レスポンス

月次利用状況の取得